All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDASynch

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---CATIAVPMVDASynch
 

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


interface CATIAVPMVDASynch

This interface executes synchronization a part instance.
Role : You give a part instance to be synchronized.


Method Index


o get_Instance(ENOVIABusinessObject*&)
Gets the object on which the synchronize is to be performed.
o get_Mode()
This method gets the type of state change required for the synchronization (enum StateChange).
o get_PartReference(ENOVIABOPartReference_var&)
Returns the part reference to which the part instance will be synchronized.
o put_Instance(ENOVIABusinessObject*)
This method puts a part instance to be synchronized to the latest version.
o put_Mode(long)
This method puts the type of state change required for the synchronization (enum StateChange).
o put_PartReference(ENOVIABOPartReference_var&)
Sets the part reference to which the part instance will be synchronized.

Enumerated Type Index


o StateChange
enum StateChange describes possible changes to an instances state.

Methods


o get_Instance
public virtual HRESULT __stdcall get_Instance(ENOVIABusinessObject*& instance)=0
Gets the object on which the synchronize is to be performed. designed for user-exit for the customer, and should not be used in another context.
Parameters:
oObject
The part instance to synchronize
Returns:
S_OK in case of success, E_FAIL if the instance to synchronize is null
o get_Mode
public virtual long __stdcall get_Mode()=0
This method gets the type of state change required for the synchronization (enum StateChange).
Returns:
mode -99 if none has been set, otherwise it returns whatever has been set with put_Mode()
o get_PartReference
public virtual HRESULT __stdcall get_PartReference(ENOVIABOPartReference_var& oPartReference)= 0
Returns the part reference to which the part instance will be synchronized.
Parameters:
oPartReference
The part reference to which the part instance will be synchronized
Returns:
S_OK if successful, E_FAIL if failure or error
o put_Instance
public virtual HRESULT __stdcall put_Instance(ENOVIABusinessObject* instance)=0
This method puts a part instance to be synchronized to the latest version.
Parameters:
instance
The part instance to synchronize
Returns:
S_OK in case of success S_FALSE if instance is not a part instance E_FAIL if instance is null or some failure occurred
o put_Mode
public virtual HRESULT __stdcall put_Mode(long mode)=0
This method puts the type of state change required for the synchronization (enum StateChange).
Parameters:
mode
see enum StateChange defined above
Returns:
S_OK always
o put_PartReference
public virtual HRESULT __stdcall put_PartReference( const ENOVIABOPartReference_var& iPartReference)= 0
Sets the part reference to which the part instance will be synchronized. This method is used only when mode = UPDATE_TO_GIVEN_VERSION to identify the version to which the part instance will be synchronized. It allows the caller to request version synchronization to a version which is not the latest version.
Parameters:
iPartReference
The part reference to which we want to synchronize. It must be a later version of the same part currently referenced by the input part instance.
Returns:
S_OK if success, E_FAIL if failure or error

Enumerated Types


o StateChange
enum StateChange {
  PUT_ON_LAST_VERSION,
  UPDATE_FROM_REF,
  FULLY_UPDATE,
  NO_CHANGE,
  UPDATE_POSITION,
  UPDATE_TO_GIVEN_VERSION
}
enum StateChange describes possible changes to an instances state.

PUT_ON_LAST_VERSION : update to latest version

UPDATE_FROM_REF : update reference only (add/delete children)

FULLY_UPDATE : REFERENCE and VERSION

NO_CHANGE

UPDATE_POSITION

UPDATE_TO_GIVEN_VERSION : update to a given version


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

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