All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

AnalysisLocalEntity (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---AnalysisLocalEntity
 


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

Property Index

AnalysisImages
Returns the analysis images collection associated with an analysis entity.
AnalysisSupports
Returns the list of Analysis Supports (Selection of geometrical or mesh entities) which define the area on which the analysis is applied on.
BasicComponents
Returns the basic components collection associated with an analysis entity.
Type
Returns the type of the analysis Entity.

Method Index

AddSupportFromConstraint
Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromProduct
Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromPublication
Creates a new support and add it to the description of the Analysis Entity.
AddSupportFromReference
Creates a new support and add it to the description of the Analysis Entity.
GetReference
Returns the reference corresponding to the given component.
GetValue
Returns the value corresponding to the given component.
SetReference
Sets the reference corresponding to the given component.
SetValue
Sets the value corresponding to the given component.

Properties


o Property AnalysisImages() As CATIAAnalysisImages (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
o Property AnalysisSupports() As CATIAAnalysisSupports (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.
o Property BasicComponents() As CATIABasicComponents (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
o Property Type() As CATBSTR (Read Only)
Returns the type of the analysis Entity.
Returns:
The string that represent the analysis entity type.

Methods


o Sub AddSupportFromConstraint(CATIAProduct iConstraintProduct,
CATIAConstraint 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:
Reference, Part
o Sub AddSupportFromProduct(CATIAProduct iProduct,
CATIAReference 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:
Reference, Product
o Sub AddSupportFromPublication(CATIAProduct iProduct,
CATIAPublication 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:
Publication, Product
o Sub AddSupportFromReference(CATIAReference iReference,
CATIAReference 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:
Reference
o Func GetReference(CATBSTR iComponent,
CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex) As CATIAReference
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 Func GetValue(CATBSTR iComponent,
CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex) As CATVariant
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 Sub SetReference(CATBSTR iComponent,
CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex,
CATIAReference 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 Sub SetValue(CATBSTR iComponent,
CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex,
CATVariant 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)
 

Copyright © 2003, Dassault Systèmes. All rights reserved.