CapeUnitBase Class

Abstract base class to be used to develop unit operation models.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#Request Example
[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[ComVisibleAttribute(true)]
public abstract class CapeUnitBase : CapeObjectBase, 
	ICapeUnit, ICapeUnitReport
Inheritance
Object    CapeIdentification    CapeObjectBase    CapeUnitBase
Derived
Implements
ICapeUnit, ICapeUnitReport

Remarks

This abstract class contains all required functionality for a unit operation PMC except the Calculate() method, which is a pure virtual function that must be overridden. To use, add parameters and ports to the appropriate collection and implement the Calculate() method.

Constructors

CapeUnitBase Constructor for the unit operation.

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.
Reports Gets the list of possible reports for the unit operation.
selectedReport Gets and sets the current active report for the unit operation.
ValStatus Gets the flag to indicate the unit operation's validation status

Methods

Calculate Executes the necessary calculations involved in the unit operation model.
Edit Displays the PMC graphic interface, if available.
(Overrides CapeObjectBaseEdit)
LogMessage Writes a string to the PME's log file.
(Inherited from CapeObjectBase)
m_Ports_AddingNew 
m_Ports_ListChanged 
MyResolveEventHandler 
NotifyPropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)
OnCalculate Executes the necessary calculations involved in the unit operation model.
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.
OnPortCollectionListChanged Occurs when the list or an item in the list changes.
OnUnitOperationBeginCalculation Occurs at the start of a unit operation calculation process.
OnUnitOperationEndCalculation Occurs at the completion of a unit operation calculation process.
OnUnitOperationValidated Occurs when a unit operation is validated.
PopUpMessage Writes a message to the terminal.
(Inherited from CapeObjectBase)
ProduceReport Produces the active report for the unit operation.
RegisterFunction The function that controls COM registration.
throwException Throws and exceptiona and exposes the exception object.
(Inherited from CapeObjectBase)
UnregisterFunction This function controls the removal of the class from the COM registry when the class is unistalled.
Validate Validates the unit operation.
(Overrides CapeObjectBaseValidate(String))

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.
PortCollectionListChanged Occurs when the list or an item in the list changes.
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.
UnitOperationEndCalculation Occurs at the completion of a calculation of a unit operation.
UnitOperationValidated Occurs when the user validates the unit operation.

Fields

Extension Methods

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

See Also