All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIConnectable
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIConnectable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIConnectable
Base interface for connectable objects.
Role: Any instance of a class implementing ENOVIConnectable
can be connected to any other implementation of ENOVIConnectable
or to a connector object, through connection objects. Such an object
is an implementation of ENOVIConnexion. Methods related to connectors
are optional.
A connector is an implementation of ENOVIConnectable that also provides
CreateConnector, RemoveConnector, GetConnectors, GetConnectorTimeStamp,
GetConnectorObject, GetConnectorName methods.
Connector objects allows connection pointing to a sub-object of a more
complex object.
- See also:
- ENOVIConnexion
Method Index
- o
CheckState(long&,CATLISTV(CATIVpmFactoryObject_var)&)
- Checks connections states.
- o
CreateConnector(CATUnicodeString&)
- Creates a connector.
- o
CreateConnexion(CATUnicodeString&,CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&,CATUnicodeString&,int)
- Creates a connection.
- o
CreateDependenceConnexion(CATUnicodeString&,CATIVpmFactoryObject_var&,int)
- Creates a dependence connection.
- o
CreateDependenceConnexions(CATUnicodeString&,CATListValCATBaseUnknown_var&,SEQUENCE_octet*&,CATListValCATIVpmFactoryObject_var&,int)
- Creates many dependence connections at once.
- o
GetConnectorName(CATIVpmFactoryObject_var&,CATUnicodeString&)
- Retrieves the connector name.
- o
GetConnectorObject(CATUnicodeString&,CATIVpmFactoryObject_var&)
- Retrieves the connector object.
- o
GetConnectorTimeStamp(CATUnicodeString&,SEQUENCE_octet&)
- Retrieves a connector's time stamp.
- o
GetConnectors(CATListOfCATUnicodeString&)
- Retrieves the list of created connectors.
- o
GetConnexions(CATLISTV(CATIVpmFactoryObject_var)&,CATListOfCATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Retrieves connection objects.
- o
RemoveConnector(CATUnicodeString&)
- Removes a connector.
Methods
o CheckState
public virtual HRESULT CheckState( | long& | oState, |
| CATLISTV(CATIVpmFactoryObject_var)& | oListOfConnexionToBeSynchronized) = 0 |
-
Checks connections states.
Role:
For each connection it checks connected object states. If one of them
has a state value equal to 1, the concerned connection is appended to
the list of connections to be synchronized.
- Parameters:
-
- oState
- This state is set to 0 if all connection and connectors
are synchronized. 1 is returned if it is not the case.
- oListOfConnexionToBeSynchronized
- The list of connections. An empty list is returned if
all connection and connectors are synchronized. Otherwise it
contains the connections to be synchronized.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o CreateConnector
-
Creates a connector.
- Parameters:
-
- iConnector
- The connector's name. Connectors on a given
object must have distinct names.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o CreateConnexion
public virtual HRESULT CreateConnexion( | const CATUnicodeString& | iConnectionType, |
| CATIVpmFactoryObject_var& | oConnection, |
| const CATIVpmFactoryObject_var& | iOwner | = NULL_var, |
| const CATUnicodeString& | iConnector | = "unval", |
| int | iFiltrable | =1) = 0 |
-
Creates a connection.
- Parameters:
-
- iConnectionType
- The type of connection to be created, depends upon sub-types
of ENOVIConnexion you may have created.
- oConnection
- The reference to the newly created connection.
- iOwner
- Owner of the connection.
- iFiltrable
- A flag to indicate whether the connection can be filtered.
1
: created connection is filtrable, default value.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o CreateDependenceConnexion
public virtual HRESULT CreateDependenceConnexion( | const CATUnicodeString& | iConnexionType, |
| CATIVpmFactoryObject_var& | oConnexion, |
| int | iFiltrable | =1) = 0 |
-
Creates a dependence connection.
Role:
A dependence connection is an historical connection established
between an owner object and pointed objects. Dependence is
implemented through pointed object times stamps. This behavior
is inherited from historical connections. Dependence connections add
orientation to the historical connection. The connection owner is the
object that did create the dependence connection. The owner is not
pointed by the connection.
- Parameters:
-
- iConnexionType
- The name of the connection type to be created.
- oConnexion
- The newly created dependence connection.
- iFiltrable
- A flag to indicate whether the connection can be filtered.
1
: created connection is filtrable, default value.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o CreateDependenceConnexions
public virtual HRESULT CreateDependenceConnexions( | const CATUnicodeString& | iConnexionType, |
| const CATListValCATBaseUnknown_var& | iPointedObjects, |
| const SEQUENCE_octet*& | iTimestamps, |
| CATListValCATIVpmFactoryObject_var& | oConnexions, |
| int | iFiltrable | =1)=0 |
-
Creates many dependence connections at once. Additionally, allows dependence
connections to be created with specified timestamps.
Role:
A dependence connection is an historical connection established
between an owner object and pointed objects. Dependence is
implemented through pointed object times stamps. This behavior
is inherited from historical connections. Dependence connections add
orientation to the historical connection. The connection owner is the
object that did create the dependence connection. The owner is not
pointed by the connection.
- Parameters:
-
- iConnexionType
- The name of the connection type to be created.
- iPointedObjects
- A list of objects which will be pointed by dependence connections.
- iTimestamps
- An array of timestamps. This array may be NULL or it may be valuated. If
it is valuated, it must be the same length as iPointedObjects. Each connection
will be created using the corresponding timestamp in iTimestamps.
- oConnexions
- The newly created dependence connections.
- iFiltrable
- A flag to indicate whether the connections can be filtered.
1
: created connections are filtrable, default value.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnectorName
-
Retrieves the connector name.
- Parameters:
-
- iConnector
- The concerned connector.
- oConnector
- The retrieved name of the connector.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnectorObject
-
Retrieves the connector object.
- Parameters:
-
- iConnector
- The name of the connector to retrieve.
- oConnector
- The retrieved connector object.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnectorTimeStamp
-
Retrieves a connector's time stamp.
- Parameters:
-
- iConnector
- The name of the connector.
- oTimeStamp
- The retrieved time stamp.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnectors
-
Retrieves the list of created connectors.
- Parameters:
-
- oConnectors
- The list of created connectors.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o GetConnexions
-
Retrieves connection objects.
- Parameters:
-
- oConnection
- The retrieved list of connections objects.
- iConnectionTypeFilter
- A filter to connection types.
"all", thus returning all types.
- oConnectors
- The retrieved list of connectors name.
- iConnectionDirectionFilter
- A filter to connections directions.
Legal values:
all
: get all connections, default value.
pointed
: get connections pointed by this.
pointing
: get connection pointing to this.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
o RemoveConnector
-
Removes a connector.
- Parameters:
-
- iConnector
- The name of the connector to remove.
- Returns:
- S_OK The method succeeds.
- Returns:
- E_FAIL The method fails.
This object is included in the file: ENOVIConnectable.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces