All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIHistoricalConnexion

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---VPMInterfaces.ENOVIConnexion
        |
        +---ENOVIHistoricalConnexion
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface ENOVIHistoricalConnexion

Subclass of ENOVIConnexion.

Role Interface to connections pointing objects, connection objects and connectors through branches. An historical connection is a connection pointing objects, connectable objects and/or connectors through branches. A branch is a kind of relationship attribute object.

An historical connection also manages timestamps on pointed objects and branches. So an historical connection knows if it is synchronized with its pointed objets.

A more complex operation is to authorize an object. An authorized object represents a collection of unsynchronized objects. The authorized object is synchronous with at least one object of the collection it represents. It allows a branch to return a synchronous state on a set of equivalent objects with different timestamps instead of being synchronous only to one object. It's a kind of acceptable set of time stamps.


Method Index


o Authorize(CATIVpmFactoryObject_var&,CATUnicodeString&)
Authorizes an object.
o CheckConnectedObjectState(CATIVpmFactoryObject_var&,long&,CATUnicodeString&)
Checks a particular object synchronization state.
o CheckConnexionState(long&,int)
Checks connection synchronization state.
o GetConnectedObjectsState(CATLISTV(CATIVpmFactoryObject_var)&,CATListOfCATUnicodeString&,CATListOfInt&)
Retrieves connected objects states.
o GetConnectedObjectsState(CATLISTV(CATIVpmFactoryObject_var)&,CATListOfCATUnicodeString&,CATListOfInt&,CATUnicodeString&)
o Synchronize(CATIVpmFactoryObject_var&,CATUnicodeString&,int)
Synchronizes the connection.

Methods


o Authorize
public virtual HRESULT Authorize( const CATIVpmFactoryObject_var& iObject= NULL_var,
const CATUnicodeString& iConnector= "unval") = 0
Authorizes an object.
Parameters:
iObject
The object to authorize. The default value is NULL_var, meaning a global autorization: all pointed objects and connectors will be authorized.
iConnector
The name of the connector. The default value is "unval", it is required if the concerned object is pointed through a connector.
Returns:
S_OK The method succeeds.
Returns:
E_FAIL The method fails.
o CheckConnectedObjectState
public virtual HRESULT CheckConnectedObjectState( const CATIVpmFactoryObject_var& iConnectedObject,
long& oState,
const CATUnicodeString& iConnector= "unval") = 0
Checks a particular object synchronization state.
Parameters:
iConnectedObject
The object pointed by the connection.
oState
The output state valuated by the method.
Legal value:
  • 0: It is synchronized.
  • 1: It is not synchronized.
  • 2: It is authorized.
iConnector
The connector name. The default value is "unval" and it is required if the concerned object is pointed through a connector.
Returns:
S_OK The method succeeds.
Returns:
E_FAIL The method fails.
o CheckConnexionState
public virtual HRESULT CheckConnexionState(long& oState,
int iApplyFilter=1) = 0
Checks connection synchronization state.
Role: When an historical connection is created it takes a copy of the time stamp attribute for each pointed object. CheckConnexionState then tells if the copy and the actual time stamps are equal for each pointed object.
Parameters:
oState
The output state the method valuate this attribute.
Legal value:
  • 0: The connection is synchronized with each of its pointed object.
  • 1: not.
  • 2: If there is a missing object.
iApplyFilter
The default value is 1, that means to apply a filter.
Returns:
S_OK The method succeeds.
Returns:
E_FAIL The method fails.
o GetConnectedObjectsState
public virtual HRESULT GetConnectedObjectsState(CATLISTV(CATIVpmFactoryObject_var)& oConnectedObjects,
CATListOfCATUnicodeString& oConnectors,
CATListOfInt& oStates) = 0
Retrieves connected objects states.
Role: This method is similar to check each connected object state and then store the results in a list.
Parameters:
oConnectedObjects
The list of retrieved connected objects.
oConnectors
The list of retrieved connectors objects. oConnectors[i] is the connector of object oConnectedObjects[i].
oStates
The corresponding list of state. oStates[i] is the state of object oConnectedObjects[i].
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 GetConnectedObjectsState
public virtual HRESULT GetConnectedObjectsState(CATLISTV(CATIVpmFactoryObject_var)& oConnectedObjects,
CATListOfCATUnicodeString& oConnectors,
CATListOfInt& oStates,
const CATUnicodeString& iRole="") = 0
o Synchronize
public virtual HRESULT Synchronize( const CATIVpmFactoryObject_var& iObject= NULL_var,
const CATUnicodeString& iConnector= "unval",
int iApplyFilter=1) = 0
Synchronizes the connection.
Parameters:
iObject
The object to synchronize. The default is NULL_var, this means that the a global synchronization is done. If it is valuated, that particular pointed object will be synchronized. This object is either a connected object or the object owner of the connection.
iConnector
The name of the connector, its default value is "unval", it is required if the concerned object is pointed through a connector.
iApplyFilter
Indicates whether a filter is to be applied. Its default value is 1, that means to apply a filter.
Returns:
S_OK The method succeeds.
Returns:
E_FAIL The method fails.

This object is included in the file: ENOVIHistoricalConnexion.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.