All Frameworks Object Hierarchy This Framework Indexes
BasicComponent (Object)
Interface designed to manage Analysis Basic Components.
A Basic Component is the low level of physical descriptive data.
It is a "brick" dedicated to build the Analysis Entity or an Analysis Set .
A Basic Components can contain several Blocks.
A Block is identified by a label.
It contains entity data of the same type, organized in superimposed tables.
To create Analysis Entities with a complex structure, we have also created
a particular Basic Component dedicated to encapsulate other Basic Components.
Property Index
-
BasicComponents
- Returns the collection of Basic Components agregated by the basic component.
-
Entities
- Returns the collection of Entities agregated by the basic component.
-
Type
- Returns the type of the Basic Component.
Method Index
-
AddSupportFromProduct
- Creates a new support and add it to the description of the basic component.
-
AddSupportFromPublication
- Creates a new support and add it to the description of the Basic Component.
-
AddSupportFromReference
- Creates a new support and add it to the description of the basic component.
-
GetColumnsNumber
- Return one of the dimensions information of the Basic Component structure.
-
GetLayersNumber
- Return one of the dimensions information of the Basic Component structure.
-
GetLinesNumber
- Return one of the dimensions information of the Basic Component structure.
-
GetValue
- Return the value corresponding to the given coordinates.
-
SetDimensions
- Sets the dimensions of the basic component.
-
SetReference
- Sets the reference corresponding to the given component.
-
SetValue
- Set the value corresponding to the given coordinates.
Properties
| o Property BasicComponents( | ) As (Read Only) |
-
Returns the collection of Basic Components agregated by the basic component.
It can be (scalar value, vector, tensor,...). Depending on the type of the Basic component,
the collection can be empty.
- Example:
- This example retrieves Basic components collection
Dim MyBasicComp As BasicComponent
Dim myBasicComponents As BasicComponents
Set myBasicComponents = MyBasicComp.BasicComponents
| o Property Entities( | ) As (Read Only) |
-
Returns the collection of Entities agregated by the basic component.
Depending on the type of the Basic component,the collection can be empty.
- Example:
- This example retrieves Basic components collection
Dim MyBasicComp As BasicComponent
Dim myEntities AnalysisEntities
Set myEntities = MyBasicComp.AnalysisEntities
| o Property Type( | ) As (Read Only) |
-
Returns the type of the Basic Component.
- Returns:
- The string that represent the Basic Component type.
Methods
| o Sub AddSupportFromProduct( | | iProduct, |
| | iSupport) |
-
Creates a new support and add it to the description of the basic component.
- 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( | | iProduct, |
| | iPublication) |
-
Creates a new support and add it to the description of the Basic Component.
- 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( | | iReference, |
| | iSupport) |
-
Creates a new support and add it to the description of the basic component.
- Parameters:
-
- iReference
- the CATIA Reference that represent the object to linked.
- iSupport
- the CATIA Reference that represent the object to linked.
- See also:
- Reference, Product
| o Func GetColumnsNumber( | | iLabel) As |
-
Return one of the dimensions information of the Basic Component structure.
- Parameters:
-
- oColumnsNumber
- = Number of Columns.
| o Func GetLayersNumber( | | iLabel) As |
-
Return one of the dimensions information of the Basic Component structure.
- Parameters:
-
- oLayersNumber
- = Number of Layers.
| o Func GetLinesNumber( | | iLabel) As |
-
Return one of the dimensions information of the Basic Component structure.
- Parameters:
-
- oLinesNumber
- = Number of lines.
| o Func GetValue( | | iLabel, |
| | iLineIndex, |
| | iColumnIndex, |
| | iLayerIndex) As |
-
Return the value corresponding to the given coordinates.
- Parameters:
-
- iLabel
- = Label of the block containing the value.
- iLineIndex
- = line index of the value.
- iColumnIndex
- = column index of the value.
- iLayerIndex
- = layer index of the value.
If the the component has a single value, set these 3 parameters
to 0.
| o Sub SetDimensions( | | iLineCount, |
| | iColumnCount, |
| | iLayerCount) |
-
Sets the dimensions of the basic component.
- Parameters:
-
- iLineCount
- Number of lines.
- iColumnCount
- Number of columns.
- iLayerCount
- Number of layers.
| o Sub SetReference( | | iLabel, |
| | iLineIndex, |
| | iColumnIndex, |
| | iLayerIndex, |
| | iValue) |
-
Sets the reference corresponding to the given component.
- Parameters:
-
- 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( | | iLabel, |
| | iLineIndex, |
| | iColumnIndex, |
| | iLayerIndex, |
| | iValue) |
-
Set the value corresponding to the given coordinates.
- Parameters:
-
- iLabel
- = Label of the block containing the value.
- iLineIndex
- = line index of the value.
- iColumnIndex
- = column index of the value.
- iLayerIndex
- = layer index of the value.
If the the component has a single value, set these 3 parameters
to 0.