All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIConnexion
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIConnexion
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIConnexion
Base class for connection objects.
Role:
A connection has an owner. When the owner is
destructed so is the connection. A connection points
objects directly or through connectors objects.
Method Index
- o
Connect(CATIVpmFactoryObject_var&,CATUnicodeString&,int,CATUnicodeString&)
- Allows a connection to point to a particular
connectable object or one of its connectors.
- o
Connect(CATIVpmFactoryObject_var&,SEQUENCE_octet&,CATUnicodeString&,int,CATUnicodeString&)
- Allows a connection to point to a particular
connectable object or one of its connectors.
- o
Drop(CATIVpmFactoryObject_var&,CATUnicodeString&)
- Drops a connected object.
- o
GetConnectedObjects(CATLISTV(CATIVpmFactoryObject_var)&,CATListOfCATUnicodeString&,int)
- Retrieves pointed objects.
- o
GetConnectedObjects(CATLISTV(CATIVpmFactoryObject_var)&,CATListOfCATUnicodeString&,int,CATUnicodeString&)
-
- o
GetConnexionOwner(CATIVpmFactoryObject_var&)
- Retrieves connection's owner.
Methods
o Connect
-
Allows a connection to point to a particular
connectable object or one of its connectors.
- Parameters:
-
- iConnectableObject
- The pointed connectable object.
- iConnector
- The name of the connector, if the object is to be pointed through
one of its connectors. This of course means that
iConnectableObject must have a connector named iConnector.
The default value is "unval".
- iApplyFilter
- A flag to indicate whether a filter is to be applied.
1
: apply a filter, default value.
- iRole
- Optional parmater for V508_role
allowed values:"BB Owner" or "Published Doc"
avaialble only for R17
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o Connect
public virtual HRESULT Connect( | const CATIVpmFactoryObject_var& | iConnectableObject, |
| const SEQUENCE_octet& | iTimestamp, |
| const CATUnicodeString& | iConnector | = "unval", |
| int | iApplyFilter | =1, |
| const CATUnicodeString& | iRole | ="")=0 |
-
Allows a connection to point to a particular
connectable object or one of its connectors.
Additionally, allows timestamp of this connection
to be specified.
- Parameters:
-
- iConnectableObject
- The pointed connectable object.
- iTimestamp
- The timestamp which will be set for this connecion.
- iConnector
- The name of the connector, if the object is to be pointed through
one of its connectors. This of course means that
iConnectableObject must have a connector named iConnector.
The default value is "unval".
- iApplyFilter
- A flag to indicate whether a filter is to be applied.
1
: apply a filter, default value.
- iRole
- Optional parmater for V508_role
allowed values:"BB Owner" or "Published Doc"
avaialble only for R17
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o Drop
public virtual HRESULT Drop( | const CATIVpmFactoryObject_var& | iConnectedObject, |
| const CATUnicodeString& | iConnector | = "unval") = 0 |
-
Drops a connected object. This method detach an
object pointed by this connection.
- Parameters:
-
- iConnectedObject
- The object to be dropped.
- iConnector
- The name of the connector, necessary if
the object is pointed through a connector.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnectedObjects
-
Retrieves pointed objects.
- Parameters:
-
- oConnectedObjects
- The list of objects pointed by this connection.
- oConnectors
- The list of connectors pointed by this connection.
- iApplyFilter
- A flag to indicate whether a filter is to be applied.
1
: apply a filter, default value.
- iRole
- Optional parmater for V508_role
allowed values:"BB Owner" or "Published Doc"
avaialble only for R17
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnectedObjects
-
o GetConnexionOwner
public virtual HRESULT GetConnexionOwner( | CATIVpmFactoryObject_var& | oObject) = 0 |
-
Retrieves connection's owner.
- Parameters:
-
- oObject
- The retrieved owner object.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
This object is included in the file: ENOVIConnexion.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces