pycatia.analysis_interfaces.analysis_local_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_local_entity.AnalysisLocalEntity(com_object)¶
Note
CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectAnalysisLocalEntityRepresent the analysis local entity object.This class provides services to describe a analysis entity. It represents somelocal preprocessing activities.- 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 AnalysisEntity.Parameters:iConstraintProductthe CATIA Product of the Constraint.iConstraintthe CATIA Constraint that represent the object tolinked.See also:Reference, Part
- Parameters:
i_constraint_product (Product) –
i_constraint (Constraint) –
- 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 AnalysisEntity.Parameters:iProductthe CATIA Product that represent the object tolinked.iSupportthe CATIA Reference that represent the object tolinked.See also:Reference, Product
- 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 AnalysisEntity.Parameters:iProductthe CATIA Product that represent the object tolinked.iPublicationthe CATIA Publication that represent the object tolinked.See also:Publication, Product
- Parameters:
i_product (Product) –
i_publication (Publication) –
- 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 AnalysisEntity.Parameters:iReferencethe CATIA Reference that represent the object to linked. Thisidentification, may locate the instance of theobjectiSupportthe CATIA Reference that represent the object tolinked.See also:Reference
- 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 analysisentity.Returns:a collection of CATIAAnalysisImages.Example:This example retrieves analysis images collectionDim MyEntity As AnalysisEntityDim myAnalysisImages As AnalysisImagesSet myAnalysisImages = MyEntity.AnalysisImages
- Return type:
- 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 (Selection of geometrical or meshentities) which define the area on which the analysis is applied on.
- Return type:
- 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 analysisentity.Returns:a collection of CATIABasicComponents.Example:This example retrieves Basic components collectionDim MyEntity As AnalysisEntityDim myBasicComponents As BasicComponentsSet myBasicComponents = MyEntity.BasicComponents
- Return type:
- 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 ReferenceReturns the reference corresponding to the givencomponent.Parameters:iComponentThe identifier if the basic component.iLabelThe label of the block containing the value.iLineIndexThe line index of the value.iColumnIndexThe column index of the value.iLayerIndexThe 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:
- 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 CATVariantReturns the value corresponding to the given component.Parameters:iComponentThe identifier if the basic component.iLabelThe label of the block containing the value.iLineIndexThe line index of the value.iColumnIndexThe column index of the value.iLayerIndexThe 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:iComponentThe identifier if the basic component.iLabelThe label of the block containing the value.iLineIndexThe line index of the value.iColumnIndexThe column index of the value.iLayerIndexThe layer index of the value.If the the component has a single value, assign 0 to the 3parameters.
- 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:iComponentThe identifier if the basic component.iLabelThe label of the block containing the value.iLineIndexThe line index of the value.iColumnIndexThe column index of the value.iLayerIndexThe layer index of the value.If the the component has a single value, assign 0 to the 3parameters.Example:This example create ThisAnalysisEntity in the analysisEntitiescollectionThe entity to create is supposed to be a pressure defined in a loadset. Wewill valuate the basic component that contain the pressure data“SAMPressureMag”.Dim analysisEntities As CATIAAnalysisEntitiesDim ThisAnalysisEntity As AnalysisEntitySet 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.Returns:The string that represent the analysis entity type.
- Return type:
str