CapeObjectBase Class

Abstract base class that implements ICapeIdentification and ICapeUtilities.

Definition

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

Remarks

This abstract class contains all required functionality for ICapeIdentification and ICapeUtilities It can be inherited and used as any generalized PMC. The derived class will register itself as a CAPE-OPEN Component (Category GUID of 678c09a1-7d66-11d2-a67d-00105a42887f) and a Flowsheet monitoring Object (Category GUID of 7BA1AF89-B2E4-493d-BD80-2970BF4CBE99).

Constructors

CapeObjectBase 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.

Methods

Edit Displays the PMC graphic interface, if available.
LogMessage Writes a string to the PME's log file.
MyResolveEventHandler 
NotifyPropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)
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)
PopUpMessage Writes a message to the terminal.
RegisterFunction The function that controls COM registration.
throwException Throws and exceptiona and exposes the exception object.
UnregisterFunction This function controls the removal of the class from the COM registry when the class is unistalled.
Validate Validates the PMC.

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)
PropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)

Fields

Extension Methods

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

Explicit Interface Implementations

ICapeUtilitiesInitialize Initialization can be performed here.
ICapeUtilitiesTerminate Clean-up tasks can be performed here.

See Also