All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDASubstitute

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

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


interface CATIAVPMVDASubstitute

Interface to define the command to create a substitute instance.
Role :


Method Index


o get_BObject(ENOVIABusinessObject_var&)
Returns the instance for which the substitute will be created.
o get_Result(ENOVIABusinessObject_var&)
Returns the newly created substitute instance.
o get_Substitute(ENOVIABusinessObject_var&)
Returns the input substitute part or PS.
o put_BObject(ENOVIABusinessObject_var&)
Sets the instance for which the substitute will be created.
o put_Substitute(ENOVIABusinessObject_var&)
Sets the part or PS for the substitute instance.

Methods


o get_BObject
public virtual HRESULT get_BObject(ENOVIABusinessObject_var& ohObject)= 0
Returns the instance for which the substitute will be created.
Parameters:
oObject:
product instance or part instance.
Returns:
S_OK if successful, E_FAIL if internal error.
o get_Result
public virtual HRESULT get_Result(ENOVIABusinessObject_var& oResult) = 0
Returns the newly created substitute instance.
Parameters:
oResult
: the new substitute part instance or product instance.
o get_Substitute
public virtual HRESULT get_Substitute(ENOVIABusinessObject_var& ohSubstitute)=0
Returns the input substitute part or PS.
Parameters:
oSubstitute:
part or PS for the substitute instance.
Returns:
S_OK if successful, E_FAIL if internal error.
o put_BObject
public virtual HRESULT put_BObject( const ENOVIABusinessObject_var& ihObject)= 0
Sets the instance for which the substitute will be created.
Parameters:
object:
product instance or part instance.
Returns:
S_OK if successful, E_FAIL if internal error.
o put_Substitute
public virtual HRESULT put_Substitute( const ENOVIABusinessObject_var& ihSubstitute)= 0
Sets the part or PS for the substitute instance.
Parameters:
substitute:
part or PS for the substitute instance.
Returns:
S_OK if successful, E_FAIL if internal error.

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

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