All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMDesktopObjects Interface CATIAVPMVDAAlternatePart
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---VPMDesktopObjects.CATIAVPMVDACommand
|
+---CATIAVPMVDAAlternatePart
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAVPMVDAAlternatePart
Interface to define the command to create or remove an alternate part definition.
Role: This interface is used when creating or removing alternate part
definitions. The addition or removal of alternate parts in the Part Editor is
done using this interface.
Method Index
- o
get_AlternatePart(ENOVIABusinessObject_var&)
- Returns the input alternate part reference.
- o
get_BObject(ENOVIABusinessObject_var&)
- Returns the primary part reference for which the new alternate is being defined.
- o
get_FullfilledRequirements(CATUnicodeString&)
- Gets the V_fulfilled_requirements attribute of the newly created VPMAlternateRelation
in add mode.
- o
get_Index(int&)
- Gets the index input during put_Index or computed if the input is the alternate to be removed.
- o
get_Mode(int&)
- Gets the mode of the command.
- o
put_AlternatePart(ENOVIABusinessObject_var&)
- Sets the part reference to be added or removed as an alternate.
- o
put_BObject(ENOVIABusinessObject_var&)
- Sets the primary part reference for which the alternate will be defined.
- o
put_FullfilledRequirements(CATUnicodeString&)
- Sets the V_fulfilled_requirements attribute of the newly created VPMAlternateRelation
in add mode.
- o
put_Index(int&)
- Sets the index of the alternate to be removed.
- o
put_Mode(int&)
- Sets the mode of the command to either add the part as an alternate or
to remove the part as an alternate.
Methods
o get_AlternatePart
public virtual HRESULT get_AlternatePart( | ENOVIABusinessObject_var& | ohAltPart)=0 |
-
Returns the input alternate part reference.
- Parameters:
-
- oSubstitute:
- part reference defined as the alternate on ihObject.
- Returns:
- S_OK if successful, E_FAIL if internal error.
o get_BObject
public virtual HRESULT get_BObject( | ENOVIABusinessObject_var& | ohObject)= 0 |
-
Returns the primary part reference for which the new alternate is being defined.
- Parameters:
-
- oObject:
- part reference for which for which ihAltPart will be the new alternate.
- Returns:
- S_OK if successful, E_FAIL if internal error.
o get_FullfilledRequirements
-
Gets the V_fulfilled_requirements attribute of the newly created VPMAlternateRelation
in add mode. The default product GUI does not offer the opportunity to set this
value or to see this value. There is no logic based on this value. It is strictly for
the use of customization.
o get_Index
public virtual HRESULT get_Index( | int& | oIndex) = 0 |
-
Gets the index input during put_Index or computed if the input is the alternate to be removed.
- Parameters:
-
- oIndex:
- index of alternate being removed.
- Returns:
- S_OK if successful, E_FAIL if internal error.
o get_Mode
public virtual HRESULT get_Mode( | int& | oMode) = 0 |
-
Gets the mode of the command.
- Parameters:
-
- oMode:
- 0 = add, 1 = remove.
- Returns:
- S_OK if successful, E_FAIL if internal error.
o put_AlternatePart
public virtual HRESULT put_AlternatePart( | const ENOVIABusinessObject_var& | ihAltPart)= 0 |
-
Sets the part reference to be added or removed as an alternate. If mode is add
and the alternate already exists, the Exec() will return S_FALSE. If mode is
remove and this part is not an alternate, the Exec() will return S_FALSE. In
both cases, there is nothing to be done.
- Parameters:
-
- ihAltPart:
- part reference to be defined as the alternate on ihObject.
- 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 primary part reference for which the alternate will be defined.
- Parameters:
-
- object:
- part reference for which ihAltPart will be the new alternate.
- Returns:
- S_OK if successful, E_FAIL if internal error.
o put_FullfilledRequirements
-
Sets the V_fulfilled_requirements attribute of the newly created VPMAlternateRelation
in add mode. The default product GUI does not offer the opportunity to set this
value or to see this value. There is no logic based on this value. It is strictly for
the use of customization.
o put_Index
public virtual HRESULT put_Index( | const int& | iIndex) = 0 |
-
Sets the index of the alternate to be removed. Can be used instead of setting
the alternate part, if desired, in remove mode. Valid index range is obtained via
ENOVIABOPartReference::get_AlternateCount().
- Parameters:
-
- iIndex:
- index of alternate to be removed, must be greater than 0.
- Returns:
- S_OK if successful, E_FAIL if internal error or <= 0.
o put_Mode
public virtual HRESULT put_Mode( | const int& | iMode) = 0 |
-
Sets the mode of the command to either add the part as an alternate or
to remove the part as an alternate.
- Parameters:
-
- iMode:
- 0 = add, 1 = remove.
- Returns:
- S_OK if successful, E_FAIL if internal error.
This object is included in the file: CATIAVPMVDAAlternatePart.h
If needed, your Imakefile.mk should include the module: VDO0Commands