pycatia.analysis_interfaces.analysis_entity

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.analysis_entity.AnalysisEntity(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
AnalysisEntity

Represent the analysis entity object.
This class provides services to describe a analysis entity. It represents some
preprocessing activities.
It agregates descriptive sub-entities named Basic Components, and Analysis
Supports.
The basic component represent the physical data and the support the
localisation.
add_support_from_constraint(i_constraint_product: Product, i_constraint: Constraint) → None

Note

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

None

add_support_from_part(i_part_product: Product, i_part: Part) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromPart(Product iPartProduct,
Part 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.

See also:
Reference, Part
Parameters:
Return type:

None

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 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
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 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
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 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
Parameters:
Return type:

None

property analysis_images: AnalysisImages

Note

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

Returns the analysis images collection associated with an analysis
entity.

Example:
This example retrieves analysisimages collection .

Dim MyEntity As AnalysisEntity
Dim analysisimages As AnalysisImages
Set analysisimages = MyEntity.AnalysisImages
Return type:

AnalysisImages

property analysis_local_entities: AnalysisLocalEntities

Note

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

Returns the analysis local entity collection associated with an analysis
entity.

Example:
This example retrieves analysislocalEntity collection
.

Dim MyEntity As AnalysisEntity
Dim analysislocalEntity As AnalysisLocalEntities
Set analysislocalEntity = MyEntity.AnalysisLocalEntities
Return type:

AnalysisLocalEntities

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 basic components collection associated with an analysis
entity.

Example:
This example retrieves basiccomponents collection .

Dim MyEntity As AnalysisEntity
Dim basiccomponents As BasicComponents
Set basiccomponents = MyEntity.BasicComponents
Return type:

BasicComponents

get_reference(i_component: str, i_label: str, i_line_index: int, i_column_index: int, i_layer_index: int) → Reference

Note

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

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

  • i_component (str) –

  • i_label (str) –

  • i_line_index (int) –

  • i_column_index (int) –

  • i_layer_index (int) –

Return type:

Reference

get_value(i_component: str, 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 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.
Parameters:

  • i_component (str) –

  • i_label (str) –

  • i_line_index (int) –

  • i_column_index (int) –

  • i_layer_index (int) –

Return type:

cat_variant

set_reference(i_component: str, 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 iComponent,
CATBSTR iLabel,
long iLineIndex,
long iColumnIndex,
long iLayerIndex,
Reference 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.
Parameters:

  • i_component (str) –

  • i_label (str) –

  • i_line_index (int) –

  • i_column_index (int) –

  • i_layer_index (int) –

  • i_value (Reference) –

Return type:

None

set_value(i_component: str, 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 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. 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)
Parameters:

  • i_component (str) –

  • 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 analysis entity.

Example:
The following example returns TypeofEntity of
MyEntity.

Dim MyEntity As AnalysisEntity
Dim TypeofEntity As CATBSTR
Set TypeofEntity = MyEntity.Type
Return type:

str