CapeOpenBase Class

Abstract base class for CAPE-OPEN unit operation wrappers in DWSIM. Implements CAPE-OPEN utilities and stream persistence interfaces so that derived classes can be hosted inside third-party CAPE-OPEN-compliant simulators.

Definition

Namespace: DWSIM.UnitOperations.UnitOperations.CAPEOPENWrappers
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 10.0.0.0
C#Request Example
[SerializableAttribute]
[ComVisibleAttribute(true)]
public abstract class CapeOpenBase : CapeUnitBase, 
	IPersistStreamInit
Inheritance
Object    CapeIdentification    CapeObjectBase    CapeUnitBase    CapeOpenBase
Derived
Implements
IPersistStreamInit

Constructors

Properties

ComponentDescription Gets and sets the description of the component.
(Inherited from CapeIdentification)
ComponentName Gets and sets the name of the component.
(Inherited from CapeIdentification)
Parameters Gets the component's collection of parameters.
(Inherited from CapeObjectBase)
Ports Gets the collection of unit operation ports.
(Inherited from CapeUnitBase)
Reports Gets the list of possible reports for the unit operation.
(Inherited from CapeUnitBase)
selectedReport Gets and sets the current active report for the unit operation.
(Inherited from CapeUnitBase)
simulationContext Sets the CAPE-OPEN simulation context object provided by the host simulator.
ValStatus Gets the flag to indicate the unit operation's validation status
(Inherited from CapeUnitBase)

Methods

Calculate Performs the unit operation calculation. Must be implemented by derived classes.
CreateParameters Creates and registers the CAPE-OPEN parameter collection for this unit operation. Must be implemented by derived classes.
Edit Displays the PMC graphic interface, if available.
(Inherited from CapeUnitBase)
GetClassID Returns the CLSID of the persisted class to the caller.
GetSizeMax Returns the maximum byte size of the serialised state stream.
Initialize Initialises the unit operation within the host CAPE-OPEN simulator, setting the UI culture and registering unhandled-exception handlers.
InitNew Initialises the unit operation to a default state when no previously saved data is available.
IsDirty Returns whether the unit operation state has changed since the last save.
Load Deserialises the unit operation parameter values from a COM stream.
LogMessage Writes a string to the PME's log file.
(Inherited from CapeObjectBase)
MyResolveEventHandler 
NotifyPropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)
OnCalculate Called by the base CAPE-OPEN unit when a calculation is triggered. Override in derived classes to perform the calculation.
(Overrides CapeUnitBaseOnCalculate)
OnComponentDescriptionChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
OnComponentNameChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
OnPortCollectionAddingNew Occurs before an item is added to the list.
(Inherited from CapeUnitBase)
OnPortCollectionListChanged Occurs when the list or an item in the list changes.
(Inherited from CapeUnitBase)
OnUnitOperationBeginCalculation Occurs at the start of a unit operation calculation process.
(Inherited from CapeUnitBase)
OnUnitOperationEndCalculation Occurs at the completion of a unit operation calculation process.
(Inherited from CapeUnitBase)
OnUnitOperationValidated Occurs when a unit operation is validated.
(Inherited from CapeUnitBase)
PopUpMessage Writes a message to the terminal.
(Inherited from CapeObjectBase)
ProduceReport Produces the active report for the unit operation.
(Inherited from CapeUnitBase)
Save Serialises the unit operation parameter values to a COM stream.
Terminate Terminates the unit operation and releases the simulation context COM object.
throwException Throws and exceptiona and exposes the exception object.
(Inherited from CapeObjectBase)
UnhandledException 
UnhandledException2 
Validate Validates the unit operation.
(Inherited from CapeUnitBase)

Events

ComponentDescriptionChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
ComponentNameChanged Occurs when the user changes of the name of a component.
(Inherited from CapeIdentification)
PortCollectionAddingNew Occurs when the user Adds a new element to the port collection.
(Inherited from CapeUnitBase)
PortCollectionListChanged Occurs when the list or an item in the list changes.
(Inherited from CapeUnitBase)
PropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)
UnitOperationBeginCalculation Occurs when the user begins the calculation of the unit operation.
(Inherited from CapeUnitBase)
UnitOperationEndCalculation Occurs at the completion of a calculation of a unit operation.
(Inherited from CapeUnitBase)
UnitOperationValidated Occurs when the user validates the unit operation.
(Inherited from CapeUnitBase)

Fields

Extension Methods

GetEnumNames
(Defined by General)
IsValidDouble
(Defined by General)

See Also