CATMecModLiveUseItf Interface CATIMmiUsePrtPart

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


interface CATIMmiUsePrtPart

Interface to retrieve information on the MechanicalPart feature.
Role: This interface is implemented on the MechanicalPart feature. This feature is named Part in the specification tree. With this interface and the interface you have all the methods to manage this feature.


Method Index


o GetInWorkObject(CATIMmiMechanicalFeature_var&)
Returns the current feature of the MechanicalPart feature.
o GetInWorkObjectTool(CATIBasicTool_var&)
Returns the current set of the MechanicalPart feature.
o RetrieveBodyForExternalReferences(CATIMmiMechanicalFeature_var&)
Returns the feature containing external references of a contextual part.
o RetrieveBodyForIsolatedExternalReferences(CATIMmiMechanicalFeature_var&)
Returns the feature containing isolated external references of a contextual part.
o RetrieveDefaultValuesBag(CATBaseUnknown_var&)
Returns the feature holding the set of default values.
o RetrieveElectedFeature(CATBaseUnknown_var&)
Returns the elected feature of the MechanicalPart feature.
o RetrieveElectedFeature(CATIMmiMechanicalFeature_var&)
o RetrieveImportedBodies(CATListValCATIMmiMechanicalFeature_var&)
Returns the list of the imported body features in the MechanicalPart feature.
o RetrieveReferencePlanes(CATListValCATIMmiMechanicalFeature_var&)
Returns a list containing the reference planes of the MechanicalPart feature.
o RetrieveRelayToElectedFeature(CATBaseUnknown_var&)
Returns the relay feature to the elected feature of the MechanicalPart feature.
o RetrieveRelayToElectedFeature(CATIMmiMechanicalFeature_var&)
o SetInWorkObject(CATIMmiMechanicalFeature_var)
Sets the current feature of the MechanicalPart feature.

Methods


o GetInWorkObject
public virtual GetInWorkObject( oInWorkObject)
Returns the current feature of the MechanicalPart feature.
Role:This method returns the mechanical feature set by the method, or by the "Define In Work Object" command in an interactive session.
Parameters:
oInWorkObject
The current feature.
o GetInWorkObjectTool
public virtual GetInWorkObjectTool( oCurrentSet)
Returns the current set of the MechanicalPart feature.
Returns:
The current set feature. It can be a Body feature, and Ordered Geometrical Set feature, or a Geometrical Set feature.
o RetrieveBodyForExternalReferences
public virtual RetrieveBodyForExternalReferences( oBody)
Returns the feature containing external references of a contextual part.
o RetrieveBodyForIsolatedExternalReferences
public virtual RetrieveBodyForIsolatedExternalReferences( oBody)
Returns the feature containing isolated external references of a contextual part.
o RetrieveDefaultValuesBag
public virtual RetrieveDefaultValuesBag( oBag)
Returns the feature holding the set of default values.
o RetrieveElectedFeature
public virtual RetrieveElectedFeature( oElectedFeature)
Returns the elected feature of the MechanicalPart feature.
o RetrieveElectedFeature
public virtual RetrieveElectedFeature( oElectedFeature)
Deprecated:
: Use similar method with CATBaseUnknown_var
o RetrieveImportedBodies
public virtual RetrieveImportedBodies( oImportedBodies)
Returns the list of the imported body features in the MechanicalPart feature.
o RetrieveReferencePlanes
public virtual RetrieveReferencePlanes( oListOfPlanes)
Returns a list containing the reference planes of the MechanicalPart feature.
Role:The list contains : xy plane, yz plane and zx plane in that order in the list.
o RetrieveRelayToElectedFeature
public virtual RetrieveRelayToElectedFeature( oRelay)
Returns the relay feature to the elected feature of the MechanicalPart feature.
o RetrieveRelayToElectedFeature
public virtual RetrieveRelayToElectedFeature( oRelay)
Deprecated:
: Use similar method with CATBaseUnknown_var
o SetInWorkObject
public virtual SetInWorkObject( iInWorkObject)
Sets the current feature of the MechanicalPart feature.
Role:This method is equivalent to the "Define In Work Object" command in an interactive session.
Parameters:
iInWorkObject
The current feature.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.