AnalysisLocalEntity (Object)

Represent the analysis local entity object.
This class provides services to describe a analysis entity. It represents some local preprocessing activities.

Properties


Property AnalysisImages() As (Read Only)
Returns the analysis images collection associated with an analysis entity.
Returns:
a collection of CATIAAnalysisImages.
Example:
 This example retrieves analysis images collection 
 Dim MyEntity As AnalysisEntity
 Dim myAnalysisImages As AnalysisImages
 Set myAnalysisImages = MyEntity.AnalysisImages
Property AnalysisSupports() As (Read Only)
Returns the list of Analysis Supports (Selection of geometrical or mesh entities) which define the area on which the analysis is applied on.
Property BasicComponents() As (Read Only)
Returns the basic components collection associated with an analysis entity.
Returns:
a collection of CATIABasicComponents.
Example:
 This example retrieves Basic components collection 
 Dim MyEntity As AnalysisEntity
 Dim myBasicComponents As BasicComponents
 Set myBasicComponents = MyEntity.BasicComponents
Property Type() As (Read Only)
Returns the type of the analysis Entity.
Returns:
The string that represent the analysis entity type.

Methods


Sub 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.
See also:
,
Sub 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.
See also:
,
Sub AddSupportFromPublication( iProduct, 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.
See also:
,
Sub 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.
See also:
Func GetReference( iComponent, iLabel, iLineIndex, iColumnIndex, iLayerIndex) As
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.
Func GetValue( iComponent, iLabel, iLineIndex, iColumnIndex, iLayerIndex) As
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.
Sub SetReference( iComponent, iLabel, iLineIndex, iColumnIndex, 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.
Sub SetValue( iComponent, iLabel, iLineIndex, iColumnIndex, iLayerIndex, 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.
Example:
 This example create ThisAnalysisEntity in the analysisEntities collection 
The entity to create is supposed to be a pressure defined in a load set. We
will valuate the basic component that contain the pressure data "SAMPressureMag".
 Dim analysisEntities As CATIAAnalysisEntities
 Dim ThisAnalysisEntity As AnalysisEntity
 Set ThisAnalysisEntity = analysisEntities.Add("SAMPressure")
 ThisAnalysisEntity.SetValue("SAMPressureMag"," ",0,0,0,100)