All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Class CATSamAnalysisEntityAdaptIDL
Usage: you can derive this class.
public class CATSamAnalysisEntityAdaptIDL
Root object used to implement derived classes of CATIAAnalysisEntity.
This class is required for build time consideration. You should not use it directely.
- See also:
- CATSamAnalysisEntityImpl
Constructor and Destructor Index
- o
~CATSamAnalysisEntityAdaptIDL()
- Default destructor.
- o
CATSamAnalysisEntityAdaptIDL()
- Default constructor.
Method Index
- o
AddSupportFromConstraint(CATIAProduct*,CATIAConstraint*)
- Creates a new support and add it to the description of the Analysis Entity.
- o
AddSupportFromPart(CATIAProduct*,CATIAPart*)
- Creates a new support and add it to the description of the Analysis Entity.
- o
AddSupportFromProduct(CATIAProduct*,CATIAReference*)
- Creates a new support and add it to the description of the Analysis Entity.
- o
AddSupportFromPublication(CATIAProduct*,CATIAPublication*)
- Creates a new support and add it to the description of the Analysis Entity.
- o
AddSupportFromReference(CATIAReference*,CATIAReference*)
- Creates a new support and add it to the description of the Analysis Entity.
- o
GetItem(CATBSTR&,CATBaseDispatch*&)
- Returns an object from its name.
- o
GetReference(CATBSTR&,CATBSTR&,long,long,long,CATIAReference*&)
- Returns the reference corresponding to the given component.
- o
GetResolution(CATIScriptMethodCall*&,CATBaseDispatch*)
- Helps the resolution mechanism of the macros generation.
- o
GetValue(CATBSTR&,CATBSTR&,long,long,long,CATVariant&)
- Returns the value corresponding to the given component.
- o
SetReference(CATBSTR&,CATBSTR&,long,long,long,CATIAReference*)
- Sets the reference corresponding to the given component.
- o
SetValue(CATBSTR&,CATBSTR&,long,long,long,CATVariant&)
- Sets the value corresponding to the given component.
- o
get_AnalysisImages(CATIAAnalysisImages*&)
- Returns the analysis images collection associated with an analysis entity.
- o
get_AnalysisLocalEntities(CATIAAnalysisLocalEntities*&)
- Returns the analysis local entity collection associated with an analysis entity.
- o
get_AnalysisSupports(CATIAAnalysisSupports*&)
- Returns the list of Analysis Supports.
- o
get_BasicComponents(CATIABasicComponents*&)
- Returns the basic components collection associated with an analysis entity.
- o
get_Name(CATBSTR&)
- Returns the name of the object.
- o
get_Parent(CATBaseDispatch*&)
- Returns the parent of the object.
- o
get_Type(CATBSTR&)
- Returns the type of the object.
- o
put_Name(CATBSTR&)
- Sets the name of the object.
Constructor and Destructor
o ~CATSamAnalysisEntityAdaptIDL
| public virtual ~CATSamAnalysisEntityAdaptIDL( | ) |
-
Default destructor.
o CATSamAnalysisEntityAdaptIDL
| public CATSamAnalysisEntityAdaptIDL( | ) |
-
Default constructor.
Methods
o AddSupportFromConstraint
| public AddSupportFromConstraint( | | iConstraintProduct, |
| | iConstraint) |
-
Creates a new support and add it to the description of the Analysis Entity.
- Parameters:
-
- iConstraintProduct
- the CATIA Product of the Constraint.
- iConstraint
- the CATIA Constraint that represent the object to linked.
All implementations should not override this default implementation.
o AddSupportFromPart
| public AddSupportFromPart( | | iPartProduct, |
| | iPart) |
-
Creates a new support and add it to the description of the Analysis Entity.
- Parameters:
-
- iPartProduct
- the CATIA Product of the part.
- iPart
- the CATIA Part that represent the object to linked.
All implementations should not override this default implementation.
o AddSupportFromProduct
| public AddSupportFromProduct( | | iProduct, |
| | iSupport) |
-
Creates a new support and add it to the description of the Analysis Entity.
- Parameters:
-
- iProduct
- the CATIA Product that represent the object to linked.
- iSupport
- the CATIA Reference that represent the object to linked.
All implementations should not override this default implementation.
o AddSupportFromPublication
| public AddSupportFromPublication( | | iPartProduct, |
| | iPublication) |
-
Creates a new support and add it to the description of the Analysis Entity.
- Parameters:
-
- iProduct
- the CATIA Product that represent the object to linked.
- iPublication
- the CATIA Publication that represent the object to linked.
All implementations should not override this default implementation.
o AddSupportFromReference
| public AddSupportFromReference( | | iReference, |
| | iSupport) |
-
Creates a new support and add it to the description of the Analysis Entity.
- Parameters:
-
- iReference
- the CATIA Reference that represent the object to linked. This identification, may locate the instance of the object
- iSupport
- the CATIA Reference that represent the object to linked.
All implementations should not override this default implementation.
o GetItem
| public GetItem( | const | iNameBSTR, |
| | oObject) |
-
Returns an object from its name.
All implementations should not override this default implementation.
- Parameters:
-
- IDName
- The searched obect name
- Returns:
- The searched object
All implementations should not override this default implementation.
o GetReference
| public GetReference( | const | iComponent, |
| const | iLabel, |
| const | iLineIndex, |
| const | iColumnIndex, |
| const | iLayerIndex, |
| | oValue) |
-
Returns the reference corresponding to the given component.
- Parameters:
-
- iComponent
- The identifier if the basic component.
- iLabel
- The label of the block containing the value.
- iLineIndex
- The line index of the value.
- iColumnIndex
- The column index of the value.
- iLayerIndex
- The layer index of the value.
o GetResolution
| public virtual GetResolution( | | oResolution, |
| | iObjectToResolve) |
-
Helps the resolution mechanism of the macros generation.
Role:
CATIAutomationResolution must be implemented by objects that want to specify a custom
access path in the Automation container-content hierarchy.
- See also:
- CATIAutomationResolution
o GetValue
| public GetValue( | const | iComponent, |
| const | iLabel, |
| const | iLineIndex, |
| const | iColumnIndex, |
| const | iLayerIndex, |
| | oValue) |
-
Returns the value corresponding to the given component.
- Parameters:
-
- iComponent
- The identifier if the basic component.
- iLabel
- The label of the block containing the value.
- iLineIndex
- The line index of the value.
- iColumnIndex
- The column index of the value.
- iLayerIndex
- The layer index of the value.
o SetReference
| public SetReference( | const | iComponent, |
| const | iLabel, |
| const | iLineIndex, |
| const | iColumnIndex, |
| const | iLayerIndex, |
| | iValue) |
-
Sets the reference corresponding to the given component.
- Parameters:
-
- iComponent
- The identifier if the basic component.
- iLabel
- The label of the block containing the value.
- iLineIndex
- The line index of the value.
- iColumnIndex
- The column index of the value.
- iLayerIndex
- The layer index of the value.
If the the component has a single value, assign 0 to the 3 parameters.
o SetValue
| public SetValue( | const | iComponent, |
| const | iLabel, |
| const | iLineIndex, |
| const | iColumnIndex, |
| const | iLayerIndex, |
| const | iValue) |
-
Sets the value corresponding to the given component.
- Parameters:
-
- iComponent
- The identifier if the basic component.
- iLabel
- The label of the block containing the value.
- iLineIndex
- The line index of the value.
- iColumnIndex
- The column index of the value.
- iLayerIndex
- The layer index of the value.
If the the component has a single value, assign 0 to the 3 parameters.
o get_AnalysisImages
| public get_AnalysisImages( | | oAnalysisImages) |
-
Returns the analysis images collection associated with an analysis entity.
All implementations should not override this default implementation.
o get_AnalysisLocalEntities
| public get_AnalysisLocalEntities( | | oAnalysisLocalEntities) |
-
Returns the analysis local entity collection associated with an analysis entity.
All implementations should not override this default implementation.
o get_AnalysisSupports
| public get_AnalysisSupports( | | oSupports) |
-
Returns the list of Analysis Supports.
All implementations should not override this default implementation.
o get_BasicComponents
| public get_BasicComponents( | | oComponents) |
-
Returns the basic components collection associated with an analysis entity.
All implementations should not override this default implementation.
o get_Name
-
Returns the name of the object.
All implementations should not override this default implementation.
o get_Parent
| public virtual get_Parent( | | oParent) |
-
Returns the parent of the object.
See
CATIABase.get_Parent for a complete description of this method.
All implementations should not override this default implementation.
- Parameters:
-
- oParent
- The returned parent
o get_Type
-
Returns the type of the object.
All implementations should not override this default implementation.
o put_Name
| public put_Name( | const | iNameBSTR) |
-
Sets the name of the object.
All implementations should not override this default implementation.
This object is included in the file: CATSamAnalysisEntityAdaptIDL.h
If needed, your Imakefile.mk should include the module: CATAnalysisToolkit