pycatia.analysis_interfaces.analysis_manager

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_manager.AnalysisManager(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
AnalysisManager

Represents the root object inside an analysis document.
It aggregates all the objects making up an analysis document.
property analysis_models: AnalysisModels

Note

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

Returns the analysis model collection from the current analysis
manager.

Example:
The following example returns from RootAnalysis the root analysis
object of the active document, assumed to be an Analysis document, the
collection of analysis models.

Dim AnalysisDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
Dim analysisModels As AnalysisModels
Set analysisModels = RootAnalysis.AnalysisModels
Return type:

AnalysisModels

property analysis_sets: AnalysisSets

Note

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

Returns the analysis sets collection associated with an analysis manager.
This collection allows to access the Analysis Connection Manager that
aggregates the Analysis Connection features.

Returns:
a collection of CATIAAnalysisSets.
Return type:

AnalysisSets

create_reference_from_geometry(i_product: Product, i_geometry: Reference) → Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateReferenceFromGeometry(Product iProduct,
Reference iGeometry) As Reference

Creates a reference from a geometry. This geometry must in defined in a
document rerecened in the CATIAAnalysisLinkedDocuments
collection.

Parameters:

iProduct
The product of the geometry to be referenced that defines the
instance of the geometry.
iGeometry
The geometry to be referenced. As a reference, it can be an
CATIABoundary object of a mechanical feature.

Returns:
a reference of the couple (iProduct, iGeometry).
Parameters:
Return type:

Reference

create_reference_from_object(i_object: AnyObject) → Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateReferenceFromObject(AnyObject iObject) As
Reference

Creates a reference from an analysis object. Use of reference allows a
uniform handling of anay objects.

Parameters:

iObject
The analysis object to be referenced. It can be an AnalysisEntity
or an AnalysisSet

Returns:
The reference to the object.
Parameters:

i_object (AnyObject) –

Return type:

Reference

import_(i_document_to_import: Document) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Import(Document iDocumentToImport)

Import an existing document in an analysis document . This document can of
any type that implement the CATIADocument interface. This is implemented for
internal document formats. (like Part or Product
documents).

Example:
The following example imports an opened CATPart
document

Dim AnalysisDocument As Document
Dim PartDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
RootAnalysis.Import(PartDocument)
Parameters:

i_document_to_import (Document) –

Return type:

None

import_define_file(i_document_path: str, i_type_late: str, i_values: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ImportDefineFile(CATBSTR iDocumentPath,
CATBSTR iTypeLate,
CATSafeArrayVariant iValues)

Import an existing document in an analysis document. This document can of
any type that is managed by the CATISamImportDefine
interface.

Example:
The following example imports an CATPart document stored as FileToOpen
file. This example is also use the CATAnalysisImport Object. This object allow
to import Part, Product or Analysis documents. As of today no parameters are
mandatory for this object.

Dim arrayOfVariant(0)
FileToOpen = “e:/users/Parts/ThisIsANicePart.CATPart”
ObjectForImport = “CATAnalysisImport”
Dim AnalysisDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
RootAnalysis.ImportDefineFile(FileToOpen,CATAnalysisImport,arrayOfVariant)
Parameters:

  • i_document_path (str) –

  • i_type_late (str) –

  • i_values (tuple) –

Return type:

None

import_file(i_document_path: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ImportFile(CATBSTR iDocumentPath)

Import an existing document in an analysis document.

Deprecated:
V5R15 use ImportDefineFile instead. This document can of any type that
implement the CATISamImportDefine interface.

Example:
The following example imports an CATPart document stored as
FileToOpen file.

FileToOpen = “e:/users/Parts/ThisIsANicePart.CATPart”
Dim AnalysisDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
RootAnalysis.ImportFile(FileToOpen)
Parameters:

i_document_path (str) –

Return type:

None

property linked_documents: AnalysisLinkedDocuments

Note

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

Returns the collection containing the documents linked to analysis
document. All the CATIA documents that are linked to the different objects
(like AnalysisMeshPart of Analysis Entity) might be accessed thru that
collection.

Example:
The following example returns in documents the linked documents of the
AnalysisDocument :

Dim AnalysisDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
Dim Documents As AnalysisLinkedDocuments
Set Documents = RootAnalysis.LinkedDocuments
Return type:

AnalysisLinkedDocuments

property parameters: Parameters

Note

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

Returns the collection object containing the analysis parameters. All the
parameters that are defined in analysis objects might be accessed thru that
collection.

Example:
The following example returns in params the parameters of the
RootAnalysis from the AnalysisDocument document:

Dim AnalysisDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
Dim params As CATIAParameters
Set params = RootAnalysis.Parameters
Return type:

Parameters

property relations: Relations

Note

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

Returns the collection object containing the analysis relations. All the
relations that are defined in analysis objects might be accessed thru that
collection.

Example:
The following example returns in relation the relations of the
RootAnalysis from the AnalysisDocument document:

Dim AnalysisDocument As Document
Set AnalysisDocument = CATIA.ActiveDocument
Dim RootAnalysis As AnalysisManager
Set RootAnalysis = AnalysisDocument.Analysis
Dim relation As CATIARelations
Set relation = RootAnalysis.Relations
Return type:

Relations