pycatia.analysis_interfaces.basic_component

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.analysis_interfaces.basic_component.BasicComponent(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
BasicComponent

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.
add_support_from_product(i_product: Product, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromProduct(Product iProduct,
Reference 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
Parameters:
Return type:

None

add_support_from_publication(i_product: Product, i_publication: Publication) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromPublication(Product iProduct,
Publication 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
Parameters:
Return type:

None

add_support_from_reference(i_reference: Reference, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromReference(Reference iReference,
Reference 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
Parameters:
Return type:

None

property analysis_supports: AnalysisSupports

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AnalysisSupports() As AnalysisSupports (Read Only)

Returns the list of Analysis Supports. The support defines the area on
which the analysis is applied on.
Return type:

AnalysisSupports

property basic_components: BasicComponents

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property BasicComponents() As BasicComponents (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
Return type:

BasicComponents

property entities: AnalysisEntities

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Entities() As AnalysisEntities (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
Return type:

AnalysisEntities

get_columns_number(i_label: str) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetColumnsNumber(CATBSTR iLabel) As long

Return one of the dimensions information of the Basic Component
structure.

Parameters:

oColumnsNumber
= Number of Columns.
Parameters:

i_label (str) –

Return type:

int

get_layers_number(i_label: str) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLayersNumber(CATBSTR iLabel) As long

Return one of the dimensions information of the Basic Component
structure.

Parameters:

oLayersNumber
= Number of Layers.
Parameters:

i_label (str) –

Return type:

int

get_lines_number(i_label: str) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLinesNumber(CATBSTR iLabel) As long

Return one of the dimensions information of the Basic Component
structure.

Parameters:

oLinesNumber
= Number of lines.
Parameters:

i_label (str) –

Return type:

int

get_value(i_label: str, i_line_index: int, i_column_index: int, i_layer_index: int) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetValue(CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex) As CATVariant

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.
Parameters:

  • i_label (str) –

  • i_line_index (int) –

  • i_column_index (int) –

  • i_layer_index (int) –

Return type:

cat_variant

set_dimensions(i_line_count: int, i_column_count: int, i_layer_count: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDimensions(long iLineCount,
long iColumnCount,
long iLayerCount)

Sets the dimensions of the basic component.

Parameters:

iLineCount
Number of lines.
iColumnCount
Number of columns.
iLayerCount
Number of layers.
Parameters:

  • i_line_count (int) –

  • i_column_count (int) –

  • i_layer_count (int) –

Return type:

None

set_reference(i_label: str, i_line_index: int, i_column_index: int, i_layer_index: int, i_value: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetReference(CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex,
Reference 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.
Parameters:

  • i_label (str) –

  • i_line_index (int) –

  • i_column_index (int) –

  • i_layer_index (int) –

  • i_value (Reference) –

Return type:

None

set_value(i_label: str, i_line_index: int, i_column_index: int, i_layer_index: int, i_value: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetValue(CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex,
CATVariant 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.
Parameters:

  • i_label (str) –

  • i_line_index (int) –

  • i_column_index (int) –

  • i_layer_index (int) –

  • i_value (cat_variant) –

Return type:

None

property type: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Type() As CATBSTR (Read Only)

Returns the type of the Basic Component.

Returns:
The string that represent the Basic Component type.
Return type:

str