UnitPort Class

This class represents the behaviour of a Unit Operation connection point (Unit Operation Port). It provides different attributes for configuring the port as well as to connect it to a material, energy or information object.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

C#Request Example

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
[ComVisibleAttribute(true)]
[GuidAttribute("51066F52-C0F9-48d7-939E-3A229010E77C")]
public class UnitPort : CapeIdentification, ICapeUnitPort

VBRequest Example

<SerializableAttribute>
<ClassInterfaceAttribute(ClassInterfaceType.None)>
<TypeConverterAttribute(GetType(ExpandableObjectConverter))>
<ComVisibleAttribute(true)>
<GuidAttribute("51066F52-C0F9-48d7-939E-3A229010E77C")>
Public Class UnitPort
	Inherits CapeIdentification
	Implements ICapeUnitPort

Inheritance: Object CapeIdentification UnitPort

Implements: ICapeUnitPort

Remarks

The unit port provides the the means by which a Flowsheet Unit is connected to its streams. Streams are implemented by means of material objects.

The three types of port: material, energy and information, have a lot of functionality in common. By combining the three into one we can simplify the interface to a useful degree. Each port type is to be distinguished by the value of an attribute.

Constructors

UnitPort

Initializes a new instance of the UnitPort class.

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)
connectedObject	Returns to the client the object that is connected to this port.
direction	Returns the direction of this port and allows the developer to change the port direction. Allowed values are among those included in the CapePortDirection type).
portType	Returns the type of this port and allows the developer to change the port type (allowed types are among the ones included in the CapePortType type.

Methods

Connect	Connects an object to the port. For a material port it must be an object implementing the ICapeThermoMaterialObject interface, for Energy and Information ports it must be an object implementing the ICapeParameter interface.
Disconnect	Disconnects whatever object is connected to this port.
Disconnect(Boolean)	Disconnects whatever object is connected to this port.
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)
OnPortConnected	Occurs when the user connects a new object to the port.
OnPortDisconnected	Occurs when the user disconnects an object from the port.

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)
PortConnected	Occurs when the user connects a new object to the port.
PortDisconnected	Occurs when the user disconnects an object from the port.
PropertyChanged	Notifies the collection that the value of a proparty of the parameter has been changed. (Inherited from CapeIdentification)

Fields

isConnectObjectSerializable
m_ConnectedNonSerializableObject
m_ConnectedObject
m_Direction
m_Type
PortConnected
PortDisconnected

Extension Methods

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