ICape
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.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(4)]
void Connect(
Object objectToConnect
)VB
<DispIdAttribute(4)>
Sub Connect (
objectToConnect As Object
)Parameters
- objectToConnect Object
- The object to connect to the port.
Remarks
Method used by clients, when they request that a Port connect itself with the object
that is passed in as argument of the method. Probably, before accepting the connection,
a Port will check that the Object sent as argument is of the expected type and
according to the value of its attribute portType.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |