All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMDesktopObjects Interface 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 get_BObject( ohObject)
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 get_Result( oResult)
Returns the newly created substitute instance.
Parameters:
oResult
: the new substitute part instance or product instance.
o get_Substitute
public virtual get_Substitute( ohSubstitute)
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 put_BObject( const ihObject)
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 put_Substitute( const ihSubstitute)
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.