space_analyses_interfaces¶

clash¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.clash.Clash(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Clash

Represents the Clash object.

The Clash object is a specification of a collision detection of

products.

property annotated_views¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property AnnotatedViews() As AnnotatedViews (Read Only)

Returns the AnnotatedViews collection of the clash.

Example:

This example retrieves the AnnotatedViews collection of NewClash

Clash.

Dim TheAnnotatedViewsList As AnnotatedViews

Set TheAnnotatedViewsList = NewClash.AnnotatedViews

Returns: AnnotatedViews

property clearance¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Clearance() As double

Returns or sets the clearance value for the computation.

The clearance value must be greater than 0. Units are

Millimeter.

Example:

The first example retrieves the clearance value of NewClash

Clash.

Dim Value As double

Value = NewClash.Clearance

The second example sets the clearance value of NewClash

Clash.

NewClash.Clearance = 10.

Returns: float

property computation_type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ComputationType() As CatClashComputationType

Returns or sets the computation type.

Example:

The first example retrieves the computation type of NewClash

Clash.

Dim ComputationType As CatClashComputationType

ComputationType = NewClash.ComputationType

The second example sets the computation type of NewClash

Clash.

NewClash.ComputationType = catClashComputationTypeBetweenAll

Returns: enum cat_clash_computation_type

compute()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Compute()

Computes the conflicts.

Example:

This example computes the conflicts of NewClash

Clash.

NewClash.Compute

Returns: None

property conflicts¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Conflicts() As Conflicts (Read Only)

Returns the collection of computed Conflicts.

Example:

This example retrieves the conflicts of NewClash

Clash.

Dim NewConflicts As Conflicts

Set NewConflicts = NewClash.Conflicts

Returns: Conflicts

export(i_type=None, i_path=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Export(CatClashExportType iType,

CATBSTR iPath)

Exports the results in a XML file.

Parameters:

iType

The type of export.

iPath

The path of the file.

Example:

This example exports the results of NewClash

Clash.

Dim ThePath As String

NewClash.Export CatClashExportTypeXMLResultOnly,

“c:tmpsample.xml”

Parameters

i_type (CatClashExportType) –
i_path (str) –

Returns

None

property first_group¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property FirstGroup() As Group

Returns or sets the first group used by the computation.

Example:

The first example retrieves the first group of NewClash

Clash.

Dim FirstGroup As Group

Set FirstGroup = NewClash.FirstGroup

The second example sets the first group of NewClash

Clash.

Dim FirstGroup As Group

NewClash.FirstGroup = FirstGroup

Returns: Group

property interference_type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property InterferenceType() As CatClashInterferenceType

Returns or sets the interference type for the computation.

Example:

The first example retrieves the interference type of NewClash

Clash.

Dim InterferenceType As CatClashInterferenceType

InterferenceType = NewClash.InterferenceType

The second example sets the interference Type of NewClash

Clash.

NewClash.InterferenceType = CatClashInterferenceTypeContact

Returns: enum cat_clash_interference_type

property marker3_ds¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Marker3Ds() As Marker3Ds (Read Only)

Returns the Marker3Ds collection of the clash.

Example:

This example retrieves the Marker3Ds collection of NewClash

Clash.

Dim TheMarker3DsList As Marker3Ds

Set TheMarker3DsList = NewClash.Marker3Ds

Returns: Marker3Ds

property second_group¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property SecondGroup() As Group

Returns or sets the second group used by the computation.

Example:

The first example retrieves the second group of NewClash

Clash.

Dim SecondGroup As Group

Set SecondGroup = NewClash.SecondGroup

The second example sets the second group of NewClash

Clash.

Dim SecondGroup As Group

NewClash.SecondGroup = SecondGroup

Returns: Group

clash_result¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.clash_result.ClashResult(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

ClashResult

Represents the ClashResult object.

The ClashResult object is a set of conflicts resulting from a clash

detection.

property conflicts¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Conflicts() As Conflicts (Read Only)

Returns the collection of computed Conflicts.

Example:

This example retrieves the conflicts of NewClashResult

ClashResult.

Dim NewConflicts As Conflicts

Set NewConflicts = NewClashResult.Conflicts

Returns: Conflicts

export(i_type=None, i_path=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Export(CatClashExportType iType,

CATBSTR iPath)

Exports the results in a XML file.

Parameters:

iType

The type of export.

iPath

The path of the file.

Example:

This example exports the results of NewClashResult

ClashResult.

Dim ThePath As String

NewClashResult.Export CatClashExportTypeXMLResultOnly,

“c:tmpsample.xml”

Parameters

i_type (CatClashExportType) –
i_path (str) –

Returns

None

clash_results¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.clash_results.ClashResults(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

ClashResults

A collection of all ClashResult objects currently managed by the

application.

The results linked to a specification are not managed thru this collection (see

Clashes ).

The method GetTechnologicalObject(“ClashResults”) on the root product, allows

you to retrieve this collection.

add_from_xml(i_path=None, i_type=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func AddFromXML(CATBSTR iPath,

CatClashImportType iType) As ClashResult

Creates a ClashResult object from a XML file and adds it to the

ClashResults collection.

Parameters:

iPath

The path of the XML file.

iType

The type of import.

Returns:

The created ClashResult

Example:

This example creates a new ClashResult in the TheClashResults

collection.

Dim NewClashResult As ClashResult

Set NewClashResult = TheClashResults.AddFromXML(“c:tmpsample.xml”,

CatClashImportTypeClashOnly)

Parameters

i_path (str) –
i_type (CatClashImportType) –

Returns

ClashResult

item(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Item(CATVariant iIndex) As ClashResult

Returns a ClashResult object using its index or its name from the

ClashResults collection.

Parameters:

iIndex

The index or the name of the ClashResult to retrieve from the

collection of ClashResults. As a numerics, this index is the rank of the

ClashResult in the collection. The index of the first ClashResult in the

collection is 1, and the index of the last ClashResult is Count. As a string,

it is the name you assigned to the ClashResult.

Example:

This example retrieves in ThisClashResult the ninth

ClashResult,

and in ThatClashResult the ClashResult named

ClashResult Of MyProduct from the TheClashResults collection.

Dim ThisClashResult As ClashResult

Set ThisClashResult = TheClashResults.Item(9)

Dim ThatClashResult As ClashResult

Set ThatClashResult = TheClashResults.Item(“ClashResult Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: ClashResult

remove(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Remove(CATVariant iIndex)

Removes a ClashResult object from the ClashResults

collection.

Parameters:

iIndex

The index or the name of the ClashResult to remove from the

collection of ClashResults. As a numerics, this index is the rank of the

ClashResult in the collection. The index of the first ClashResult in the

collection is 1, and the index of the last ClashResult is Count. As a string,

it is the name you assigned to the ClashResult.

Example:

The following example removes the tenth ClashResult and the

ClashResult named

ClashResult Of MyProduct from the TheClashResults

collection.

TheClashResults.Remove(10)

TheClashResults.Remove(“ClashResult Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: None

clashes¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.clashes.Clashes(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Clashes

A collection of all Clash objects currently managed by the

application.

The method GetTechnologicalObject(“Clashes”) on the root product, allows you to

retrieve this collection.

add()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Add() As Clash

Creates a Clash object which takes all products into account and adds it to

the Clashes collection.

Returns:

The created Clash

Example:

This example creates a new Clash in the TheClashes

collection.

Dim NewClash As Clash

Set NewClash = TheClashes.Add

Returns: Clash

add_from_sel()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func AddFromSel() As Clash

Creates a Clash object which takes all products in the selection into

account and adds it to the Clashes collection.

Returns:

The created Clash

Example:

This example creates a new Clash in the TheClashes

collection.

Dim NewClash As Clash

Set NewClash = TheClashes.AddFromSel

Returns: Clash

item(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Item(CATVariant iIndex) As Clash

Returns a Clash object using its index or its name from the Clashes

collection.

Parameters:

iIndex

The index or the name of the Clash to retrieve from the collection

of Clashes. As a numerics, this index is the rank of the Clash in the

collection. The index of the first Clash in the collection is 1, and the index

of the last Clash is Count. As a string, it is the name you assigned to the

Clash.

Example:

This example retrieves in ThisClash the ninth

Clash,

and in ThatClash the Clash named

Clash Of MyProduct from the TheClashes collection.

Dim ThisClash As Clash

Set ThisClash = TheClashes.Item(9)

Dim ThatClash As Clash

Set ThatClash = TheClashes.Item(“Clash Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: Clash

remove(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Remove(CATVariant iIndex)

Removes a Clash object from the Clashes collection.

Parameters:

iIndex

The index or the name of the Clash to remove from the collection of

Clashes. As a numerics, this index is the rank of the Clash in the collection.

The index of the first Clash in the collection is 1, and the index of the last

Clash is Count. As a string, it is the name you assigned to the Clash.

Example:

The following example removes the tenth Clash and the Clash

named

Clash Of MyProduct from the TheClashes collection.

TheClashes.Remove(10)

TheClashes.Remove(“Clash Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: None

conflict¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.conflict.Conflict(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Conflict

Represents the Conflict object.

One Conflict object exists for each couple of products that are

colliding.

property comment¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Comment() As CATBSTR

Returns or sets a comment on the conflict.

Example:

The first example gets the comment of NewConflict

Conflict.

Dim aComment As String

aComment = NewConflict.Comment

The second example sets a comment on the NewConflict

Conflict.

NewConflict.Comment = “OK : plastic part”

Returns: str

property comparison_info¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ComparisonInfo() As CatConflictComparison (Read

Only)

Returns the information on the comparison between the conflict and the

previous one.

Example:

This example retrieves the comparison information of the

NewConflict Conflict.

Dim anInfo As CatConflictComparison

anInfo = NewConflict.ComparisonInfo

Returns: enum cat_conflict_comparison

property first_product¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property FirstProduct() As Product (Read Only)

Returns the first product involved in the conflict.

Example:

This example retrieves the first product involved in the

NewConflict Conflict.

Dim aProduct As Product

Set aProduct = NewConflict.FirstProduct

Returns: Product

get_first_point_coordinates(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetFirstPointCoordinates(CATSafeArrayVariant

oCoordinates)

Retrieves the coordinates of the point on the first product which realizes

the penetration or minimum distance.

Parameters:

oCoordinates

The coordinates of the point

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the first product involved in the

NewConflict Conflict.

Dim Coordinates (2)

NewConflict.GetFirstPointCoordinates Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_second_point_coordinates(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetSecondPointCoordinates(CATSafeArrayVariant

oCoordinates)

Retrieves the coordinates of the point on the second product which realizes

the penetration or minimum distance.

Parameters:

oCoordinates

The coordinates of the point

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the coordinates in the NewConflict

Conflict.

Dim Coordinates (2)

NewConflict.GetSecondPointCoordinates Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

property second_product¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property SecondProduct() As Product (Read Only)

Returns the second product involved in the conflict.

Example:

This example retrieves the second product involved in the

NewConflict Conflict.

Dim aProduct As Product

Set aProduct = NewConflict.SecondProduct

Returns: Product

property status¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Status() As CatConflictStatus

Returns or sets the status of the conflict.

Example:

The first example gets the status of NewConflict

Conflict.

Dim aStatus As CatConflictStatus

aStatus = NewConflict.Status

The second example sets the status of NewConflict

Conflict.

NewConflict.Status = CatConflictStatusIrrelevant

Returns: enum cat_conflict_status

property type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Type() As CatConflictType (Read Only)

Returns the type of the conflict.

Example:

This example retrieves the type of the NewConflict

Conflict.

Dim conflictType As CatConflictType

conflictType = NewConflict.Type

Returns: enum cat_conflict_type

property value¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Value() As double (Read Only)

Returns the conflict value.

This value is the penetration lengh in case of a clash or the minimum

distance in case of clearance violation.

Example:

This example retrieves the value of the NewConflict

Conflict.

Dim conflictValue As double

conflictValue = NewConflict.Value

Returns: float

conflicts¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.conflicts.Conflicts(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Conflicts

A collection of all Conflict objects currently detected by a Clash

object.

item(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Item(CATVariant iIndex) As Conflict

Returns a Conflict object using its index from the Conflicts

collection.

Parameters:

iIndex

The index of the Conflict object to retrieve from the collection of

Conflicts. As a numerics, this index is the rank of the Conflict in the

collection. The index of the first Conflict in the collection is 1, and the

index of the last Conflict is Count.

Example:

This example retrieves in ThisConflict the ninth

Conflict

from the TheConflicts collection.

Dim ThisConflict As Conflict

Set ThisConflict = TheConflicts.Item(9)

Parameters: i_index (CATVariant) –
Returns: Conflict

distance¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.distance.Distance(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Distance

Represents the Distance object.

The Distance object is a specification of a distance computation between

products or groups of products.

property accuracy¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Accuracy() As double

Returns or sets the accuracy value for the computation.

The accuracy value must be greater than 0.

Example:

The first example retrieves the accuracy value of NewDistance

Distance.

Dim AccuracyValue As double

AccuracyValue = NewDistance.Accuracy

The second example sets the accuracy value of NewDistance

Distance.

NewDistance.Accuracy = 10.

Returns: float

property annotated_views¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property AnnotatedViews() As AnnotatedViews (Read Only)

Returns the AnnotatedViews collection of the distance.

Example:

This example retrieves the AnnotatedViews collection of

NewDistance Distance.

Dim TheAnnotatedViewsList As AnnotatedViews

Set TheAnnotatedViewsList = NewDistance.AnnotatedViews

Returns: AnnotatedViews

property computation_type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ComputationType() As CatDistanceComputationType

Returns or sets the computation type for the computation.

Example:

The first example retrieves the computation type of NewDistance

Distance.

Dim ComputationType As CatDistanceComputationType

ComputationType = NewDistance.ComputationType

The second example sets the computation type of NewDistance

Distance.

NewDistance.ComputationType = CatDistanceComputationTypeInsideOne

Returns: enum cat_distance_computation_type

compute()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Compute()

Computes the distance.

Example:

This example computes the distance of NewDistance

Distance.

NewDistance.Compute

Returns: None

property first_group¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property FirstGroup() As Group

Returns or sets the first group used by the computation.

Example:

The first example retrieves the first group of NewDistance

Distance.

Dim FirstGroup As Group

Set FirstGroup = NewDistance.FirstGroup

The second example sets the first group of NewDistance

Distance.

Dim FirstGroup As Group

NewDistance.FirstGroup = FirstGroup

Returns: Group

property first_product¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property FirstProduct() As Product (Read Only)

Returns the product belonging to the first group that realizes the minimum

distance.

Example:

This example retrieves the first product involved in the

NewDistance Distance.

Dim AProduct As Product

Set AProduct = NewDistance.FirstProduct

Returns: Product

get_first_point_coordinates(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetFirstPointCoordinates(CATSafeArrayVariant

oCoordinates)

Retrieves the coordinates of the point belonging to the first product,

which realizes the distance.

Parameters:

oCoordinates

The coordinates of the point

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the coordinates of the first point in

NewDistance Distance.

Dim Coordinates (2)

NewDistance.GetFirstPointCoordinates Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_second_point_coordinates(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetSecondPointCoordinates(CATSafeArrayVariant

oCoordinates)

Retrieves the coordinates of the point belonging to the second product,

which realizes the distance.

Parameters:

oCoordinates

The coordinates of the point

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the coordinates of the first point in

NewDistance Distance.

Dim Coordinates (2)

NewDistance.GetSecondPointCoordinates Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

property is_defined¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property IsDefined() As long (Read Only)

Returns a diagnosis on the distance.

The diagnosis can take two values:

= 0: the distance is undefined (for example only one product) and the results are invalid.

= 1: the distance is defined and all results are valid.

Example:

This example retrieves the diagnosis on NewDistance

Distance.

If NewDistance.IsDefined = 1 Then

Returns: int

property marker3_ds¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Marker3Ds() As Marker3Ds (Read Only)

Returns the Marker3Ds collection of the distance.

Example:

This example retrieves the Marker3Ds collection of NewDistance

Distance.

Dim TheMarker3DsList As Marker3Ds

Set TheMarker3DsList = NewDistance.Marker3Ds

Returns: Marker3Ds

property maximum_distance¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property MaximumDistance() As double

Returns or sets the maximum distance value for the computation (valid only

for band analysis).

The maximum distance value must be greater than 0.

Example:

The first example retrieves the maximum distance value of

NewDistance Distance.

Dim MaximumValue As double

MaximumValue = NewDistance.MaximumDistance

The second example sets the maximum distance value of

NewDistance Distance.

NewDistance.MaximumDistance = 10.

Returns: float

property measure_type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property MeasureType() As CatDistanceMeasureType

Returns or sets the type of distance that will be

calculated.

Example:

The first example retrieves the type of NewDistance

Distance.

Dim MeasureType As CatDistanceMeasureType

MeasureType = NewDistance.MeasureType

The second example sets the Type of NewDistance

Distance.

NewDistance.MeasureType = CatDistanceMeasureTypeMinimum

Returns: enum cat_distance_measure_type

property minimum_distance¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property MinimumDistance() As double

Returns or sets the minimum distance value for the computation (valid only

for band analysis).

The minimum distance value must be greater than 0.

Example:

The first example retrieves the minimum distance value of

NewDistance Distance.

Dim MinimumValue As double

MinimumValue = NewDistance.MinimumDistance

The second example sets the minimum distance value of

NewDistance Distance.

NewDistance.MinimumDistance = 10.

Returns: float

property second_group¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property SecondGroup() As Group

Returns or sets the second group used by the computation.

Example:

The first example retrieves the second group of NewDistance

Distance.

Dim SecondGroup As Group

Set SecondGroup = NewDistance.SecondGroup

The second example sets the second group of NewDistance

Distance.

Dim SecondGroup As Group

NewDistance.SecondGroup = SecondGroup

Returns: Group

property second_product¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property SecondProduct() As Product (Read Only)

Returns the product belonging to the second group that realizes the minimum

distance.

Example:

This example retrieves the coordinates in the NewDistance

Distance.

Dim AProduct As Product

Set AProduct = NewDistance.SecondProduct

Returns: Product

property value¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Value() As double (Read Only)

Returns the distance value.

Example:

This example retrieves the value of NewDistance

Distance.

Dim MinimumValue As double

MinimumValue = NewDistance.Value

Returns: float

distances¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.distances.Distances(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Distances

A collection of all Distance objects currently managed by the

application.

The method GetTechnologicalObject(“Distances”) on the root product, allows you

to retrieve this collection.

add()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Add() As Distance

Creates a Distance object which takes all products of the document into

account and adds it to the Distances collection.

Returns:

The created Distance

Example:

This example creates a new Distance in the TheDistances

collection.

Dim NewDistance As Distance

Set NewDistance = TheDistances.Add

Returns: Distance

add_from_sel()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func AddFromSel() As Distance

Creates a Distance object which takes all products in the selection into

account and adds it to the Distances collection.

Returns:

The created Distance

Example:

This example creates a new Distance in the TheDistances

collection.

Dim NewDistance As Distance

Set NewDistance = TheDistances.AddFromSel

Returns: Distance

item(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Item(CATVariant iIndex) As Distance

Returns a Distance object using its index or its name from the Distances

collection.

Parameters:

iIndex

The index or the name of the Distance to retrieve from the

collection of Distances. As a numerics, this index is the rank of the Distance

in the collection. The index of the first Distance in the collection is 1, and

the index of the last Distance is Count. As a string, it is the name you

assigned to the Distance.

Example:

This example retrieves in ThisDistance the ninth

Distance,

and in ThatDistance the Distance named

Distance Of MyProduct from the TheDistances collection.

Dim ThisDistance As Distance

Set ThisDistance = TheDistances.Item(9)

Dim ThatDistance As Distance

Set ThatDistance = TheDistances.Item(“Distance Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: Distance

remove(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Remove(CATVariant iIndex)

Removes a Distance object from the Distances collection.

Parameters:

iIndex

The index or the name of the Distance to remove from the collection

of Distances. As a numerics, this index is the rank of the Distance in the

collection. The index of the first Distance in the collection is 1, and the

index of the last Distance is Count. As a string, it is the name you assigned

to the Distance.

Example:

The following example removes the tenth Distance and the Distance

named

Distance Of MyProduct from the TheDistances

collection.

TheDistances.Remove(10)

TheDistances.Remove(“Distance Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: None

general_functions¶

pycatia.space_analyses_interfaces.general_functions.create_measurable(spa_workbench, com_reference)¶

Parameters

spa_workbench –
com_reference –

Returns

inertia¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.inertia.Inertia(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Inertia

Represents the Inertia object.

The Inertia object can be associated with any relevant object of a document in

order to get or compute its inertia data. It takes into account all bodies of a

part.

This version allows you to compute the following data:

mass

density

position of the center of gravity

inertia matrix

principal axes

principal moments

of a product.

The units are:

Kilogram (Kg) for Mass

Square meter (M^2) for Wet Area

Cubic meter (M^3) for Volume

Meter (M) for Position

Square Kilogram meter ((KgM)^2) for Inertia Matrix and Principal

Moments

Kilogram per cubic meter (Kg/M^3) for Density

The method GetTechnologicalObject(“Inertia”) on the product to analyze, allows

you to retrieve this object.

property density¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Density() As double

Returns or sets the density for the computation.

The density value is set to:

0: the computation must use densities attached to each

object.

any positive value: the computation has to use this value.

The density value is returned as:

1: a default value is used (there is no density attached to

objects).

-1: the density is not homogeneous for each object.

other positive values: the density attached to all objects.

Example:

The first example gets the density of NewInertia

inertia.

Dim ADensity As double

ADensity = NewInertia.Density

The second example sets the density of NewInertia

inertia.

NewInertia.Density = 10.

Returns: float

get_cog_position(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetCOGPosition(CATSafeArrayVariant oCoordinates)

Retrieves the position of the center of gravity.

Parameters:

oCoordinates

The position of the center of gravity with respect to the product

coordinate system:

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the position of the center of gravity of

NewInertia inertia.

Dim Coordinates (2)

NewInertia.GetCOGPosition Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_inertia_matrix(o_matrix=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetInertiaMatrix(CATSafeArrayVariant oMatrix)

Retrieves the matrix of inertia.

Parameters:

oMatrix

The matrix of inertia array:

oMatrix(0) is the Ixx component

oMatrix(1) is the Ixy component

oMatrix(2) is the Ixz component

oMatrix(3) is the Iyx component

oMatrix(4) is the Iyy component

oMatrix(5) is the Iyz component

oMatrix(6) is the Izx component

oMatrix(7) is the Izy component

oMatrix(8) is the Izz component

Example:

This example retrieves the matrix of inertia of NewInertia

inertia.

Dim Matrix (8)

NewInertia.GetInertiaMatrix Matrix

Parameters: o_matrix (tuple) –
Returns: None

get_principal_axes(o_components=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPrincipalAxes(CATSafeArrayVariant oComponents)

Retrieves the the principal axes of inertia.

Parameters:

oComponents

The principal axes of inertia array (A1, A2 and A3 are the

principal axes of inertia):

oComponents(0) is the A1x component

oComponents(1) is the A2x component

oComponents(2) is the A3x component

oComponents(3) is the A1y component

oComponents(4) is the A2y component

oComponents(5) is the A3y component

oComponents(6) is the A1z component

oComponents(7) is the A2z component

oComponents(8) is the A3z component

Example:

This example retrieves the principal axes of inertia of NewInertia

inertia.

Dim Components (8)

NewInertia.GetPrincipalAxes Components

Parameters: o_components (tuple) –
Returns: None

get_principal_moments(o_values=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPrincipalMoments(CATSafeArrayVariant oValues)

Retrieves the principal moments of inertia.

Parameters:

oValues

The principal moments of inertia array:

oValues(0) is the M1 value with respect to the first principal

exes of inertia

oValues(1) is the M2 value with respect to the second principal

exes of inertia

oValues(2) is the M3 value with respect to the third principal

exes of inertia

Example:

This example retrieves principal moments of inertia of NewInertia

inertia.

Dim Values (2)

NewInertia.GetPrincipalMoments Values

Parameters: o_values (tuple) –
Returns: None

property granularity_mode¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GranularityMode() As long

Returns or sets the Granularity Mode for Inertia

Computation.

The Granularity value is set to:

0: Only main bodies option is selected => the computation must not use

All bodies.

1: Only main bodies option is not selected => the computation must use

All bodies.

The Granularity value is returned as:

0: the computation had considered only main bodies.

1: the computation had not considered only main bodies.

Example:

The first example gets the Granularity of NewInertia

inertia.

Dim AGranularityMode As Integer

AGranularityMode = NewInertia.GranularityMode

The second example sets the Granularity of NewInertia inertia

to deselect the “only main bodies”.

NewInertia.GranularityMode = 1

Returns: int

property mass¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Mass() As double (Read Only)

Returns the mass.

Example:

This example retrieves the mass of NewInertia

inertia.

Dim AMass As double

AMass = NewInertia.Mass

Returns: float

inertias¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.inertias.Inertias(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Inertias

A collection of all inertia objects currently managed by the

application.

WARNING: this collection will be DEPRECATED in the next release. It is

recommended to use the method GetTechnologicalObject(“Inertia”) on the product

to analyze, to retrieve an Inertia object.

add(i_object=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Add(AnyObject iObject) As Inertia

Creates an Inertia object from an object and adds it to the Inertias

collection.

Parameters:

iObject

The Object

Returns:

The created Inertia

Example:

This example creates a new Inertia from a product

TheProduct

in the TheInertias collection.

Dim NewInertia As Inertia

Set NewInertia = TheInertias.Add(TheProduct)

Parameters: i_object (AnyObject) –
Returns: Inertia

item(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Item(CATVariant iIndex) As Inertia

Returns an Inertia object using its index or its name from the Inertias

collection.

Parameters:

iIndex

The index or the name of the Inertia to retrieve from the

collection of inertias. As a numerics, this index is the rank of the Inertia in

the collection. The index of the first Inertia in the collection is 1, and the

index of the last Inertia is Count. As a string, it is the name you assigned to

the Inertia.

Example:

This example retrieves in ThisInertia the ninth

Inertia,

and in ThatInertia the Inertia named

Inertia Of MyProduct from the TheInertias collection.

Dim ThisInertia As Inertia

Set ThisInertia = TheInertias.Item(9)

Dim ThatInertia As Inertia

Set ThatInertia = TheInertias.Item(“Inertia Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: Inertia

remove(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Remove(CATVariant iIndex)

Removes an Inertia object from the Inertias collection.

Parameters:

iIndex

The index or the name of the Inertia to remove from the collection

of inertias. As a numerics, this index is the rank of the Inertia in the

collection. The index of the first Inertia in the collection is 1, and the

index of the last Inertia is Count. As a string, it is the name you assigned to

the Inertia.

Example:

The following example removes the tenth Inertia and the Inertia

named

Inertia Of MyProduct from the TheInertias

collection.

TheInertias.Remove(10)

TheInertias.Remove(“Inertia Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: None

measurable¶

class pycatia.space_analyses_interfaces.measurable.Measurable(com_object)¶

The interface to access a CATIAMeasurable Get measurements on the object.

Note

CAA V5 Visual Basic help

Two types of measurement can be done:

itself : gives dimensions related to the object itself (ex the radius of a circle).
between : gives dimensions related to another object (ex the distance between two products).
A restriction occurs for distance between: bodies (CATBody) cannot be measured.

Methods on VOLUME : GetVolume GetArea GetCOG
Methods on SURFACE : GetArea GetCOG GetPerimeter
Methods on PLANE : GetArea GetCOG GetPlane
Methods on CYLINDER : GetArea GetCOG GetAxis GetPointsOnAxis GetRadius
Methods on CONE : GetArea GetCOG GetAxis GetPointsOnAxis GetAngle
Methods on SPHERE : GetArea GetCOG GetRadius GetCenter
Methods on CURVE : GetLength GetCOG GetPointsOnCurve
Methods on LINE : GetLength GetCOG GetPointsOnCurve GetDirection
Methods on CIRCLE : GetLength GetCOG GetPointsOnCurve GetRadius GetCenter GetAngle GetAxis
Methods on POINT : GetPoint
Methods on AXIS SYST : GetAxisSystem

property angle¶

Note

CAA V5 Visual Basic help

Property Angle( ) As double (Read Only)

Returns the Angle of a circle or cone.
Example:
This example retrieves the Angle of NewMeasurable measure.

Dim AAngle As double
AAngle = NewMeasurable.Angle

Returns: float

property area¶

Note

CAA V5 Visual Basic help

Property Area( ) As double (Read Only)

Returns the area of the surface or wet area from volume.

Example:

This example retrieves the area of NewMeasurable measure. The area unit given by oArea is m²

Dim AArea As double

AArea = NewMeasurable.Area

Returns: float

property geometry_name¶

Note

CAA V5 Visual Basic help

Property GeometryName( ) As CatMeasurableName (Read Only)

Returns the name of the geometry of the measured object.

Example:

This example retrieves the name of the geometry of the NewMeasurable measure.

Dim AGeometryName As CatMeasurableName

AGeometryName = NewMeasurable.GeometryName

Returns: int enumeration_type.measurable_name

get_angle_between(i_measured_item)¶

Note

CAA V5 Visual Basic help

Func GetAngleBetween( Reference iMeasuredItem) As double

Compute the angle between the CATIAMeasurable and another.
Example:
This example retrieves the angle between the reference1 and reference2.

Dim reference1 As Reference

Set reference1 = part1.CreateReferenceFromObject(object1)

Dim reference2 As Reference

Set reference2 = part1.CreateReferenceFromObject(object1)

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheMeasurable As Measurable

Set TheMeasurable = TheSPAWorkbench.GetMeasurable(reference1)

Dim MinimumDistance As double

MinimumDistance = TheMeasurable.GetAngleBetween(reference2)

Returns: float

get_axis()¶

..note::

CAA V5 Visual Basic help

Sub GetAxis( CATSafeArrayVariant oAxisVector)

Retrieves the axis vector of the cylinder or a cone.
Parameters:
oVector
The axis vector of the cylinder or a cone with respect to the product coordinate system:
oAxisVector(0) is the X direction
oAxisVector(1) is the Y direction
oAxisVector(2) is the Z direction
Example:
This example retrieves the axis vector of the cylinder or a cone of NewMeasurable measure.
Dim AxisVector (2)
NewMeasurable.GetAxis AxisVector

Returns: tuple(float, float, float)

get_axis_system()¶

..note ::

CAA V5 Visual Basic help

Sub GetAxisSystem( CATSafeArrayVariant oComponents)

Retrieves the information of the axis system.
Parameters:
oCoordinates
The information of the axis system with respect to the product coordinate system:
oComponents(0) is the X coordinate of the origin of the axis system
oComponents(1) is the Y coordinate of the origin of the axis system
oComponents(2) is the Z coordinate of the origin of the axis system
oComponents(3) is the X coordinate of the first direction of the axis system
oComponents(4) is the Y coordinate of the first direction of the axis system
oComponents(5) is the Z coordinate of the first direction of the axis system
oComponents(6) is the X coordinate of the second direction of the axis system
oComponents(7) is the Y coordinate of the second direction of the axis system
oComponents(8) is the Z coordinate of the second direction of the axis system
oComponents(9) is the X coordinate of the third direction of the axis system
oComponents(10) is the Y coordinate of the third direction of the axis system
oComponents(11) is the Z coordinate of the third direction of the axis system
Example:
This example retrieves information of the axis system of NewMeasurable measure.
Dim Components (11)
NewMeasurable.GetAxisSystem Components

Returns: tuple(float, float, float, float, float, float, float, float, float, float, float, float)

get_center()¶

..note::: CAA V5 Visual Basic help Sub GetCenter( CATSafeArrayVariant oCoordinates)

Retrieves the position of the center of a circle or sphere.

Parameters:

oCoordinates

The position of the center with respect to the product coordinate system:

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the position of the center of NewMeasurable measure.

Dim Coordinates (2)

NewMeasurable.GetCenter Coordinates << fixed typo in help

Returns: tuple(float, float, float)

get_cog()¶

Note

FROM CAA V5 Visual Basic help

Sub GetCOG( CATSafeArrayVariant oCoordinates)

Retrieves the position of the center of gravity of a surface and volume .
Parameters:
oCoordinates
The position of the center of gravity with respect to the product coordinate system:
oCoordinates(0) is the X coordinate
oCoordinates(1) is the Y coordinate
oCoordinates(2) is the Z coordinate
Example:
This example retrieves the position of the center of gravity of NewMeasurable measure.
Dim Coordinates (2)
NewMeasurable.GetCOG Coordinates

Returns: tuple(float, float, float)

get_direction()¶

Note

CAA V5 Visual Basic help

Sub GetDirection( CATSafeArrayVariant oDirection)

Retrieves the direction of the line.
Parameters:
oDirection
The direction of the line with respect to the product coordinate system:
oDirection(0) is the X direction
oDirection(1) is the Y direction
oDirection(2) is the Z direction
Example:
This example retrieves the direction of the line of NewMeasurable measure.
Dim Direction (2)
NewMeasurable.GetDirection Direction

Returns: tuple(float, float, float)

get_minimum_distance(i_measured_item)¶

Note

CAA V5 Visual Basic help

Func GetMinimumDistance( Reference iMeasuredItem) As double

Compute the minimum distance between the CATIAMeasurable and another.
Bodies (openbody, hybridbody..) cannot be measured between.
Parameters:
oCoordinates
The information of the axis system with respect to the product coordinate system:
oComponents(0) is the X coordinate of the origin of the axis system
oComponents(1) is the Y coordinate of the origin of the axis system
oComponents(2) is the Z coordinate of the origin of the axis system
oComponents(3) is the X coordinate of the first direction of the axis system
oComponents(4) is the Y coordinate of the first direction of the axis system
oComponents(5) is the Z coordinate of the first direction of the axis system
Example:
This example retrieves the distance between the reference1 and reference2.
Dim reference1 As Reference
Set reference1 = part1.CreateReferenceFromObject(object1)
Dim reference2 As Reference
Set reference2 = part1.CreateReferenceFromObject(object1)
Dim TheSPAWorkbench As Workbench
Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )
Dim TheMeasurable As Measurable
Set TheMeasurable = TheSPAWorkbench.GetMeasurable(reference1)
Dim MinimumDistance As double
MinimumDistance = TheMeasurable.GetMinimumDistance(reference2)

Returns: float

get_minimum_distance_points(i_measured_item)¶

Note

CAA V5 Visual Basic help

Sub GetMinimumDistancePoints( Reference iMeasuredItem, CATSafeArrayVariant oCoordinates)

Compute the points corresponding to the minimum distance between the two references.

Example:

This example retrieves the points corresponding to the distance between the reference1 and reference2.

Dim reference1 As Reference
Set reference1 = part1.CreateReferenceFromObject(object1)
Dim reference2 As Reference
Set reference2 = part1.CreateReferenceFromObject(object1)
Dim TheSPAWorkbench As Workbench
Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )
Dim TheMeasurable As Measurable
Set TheMeasurable = TheSPAWorkbench.GetMeasurable(reference1)
Dim Coordinates (8)
TheMeasurable.GetMinimumDistancePoints reference2, Coordinates

Parameters: i_measured_item –
Returns: tuple(float, float, float, float, float, float, float, float)

get_plane()¶

Note

CAA V5 Visual Basic help

Sub GetPlane( CATSafeArrayVariant oComponents)

Retrieves informations of the plane.
Parameters:
oComponents
The informations of the plane with respect to the product coordinate system:
oComponents(0) is the X coordinate of the origin
oComponents(1) is the Y coordinate of the origin
oComponents(2) is the Z coordinate of the origin
oComponents(3) is the X coordinate of the first direction of the plane
oComponents(4) is the Y coordinate of the first direction of the plane
oComponents(5) is the Z coordinate of the first direction of the plane
oComponents(6) is the X coordinate of the second direction of the plane
oComponents(7) is the Y coordinate of the second direction of the plane
oComponents(8) is the Z coordinate of the second direction of the plane
Example:
This example retrieves informations of the plane of NewMeasurable measure.
Dim Components (8)
NewMeasurable.GetPlane Components

Returns: tuple(float, float, float, float, float, float, float, float)

get_point()¶

Note

CAA V5 Visual Basic help Sub GetPoint( CATSafeArrayVariant oCoordinates)

Retrieves the position of the point.
Parameters:
oCoordinates
The coordinate of the point with respect to the product coordinate system:
oCoordinates(0) is the X coordinate
oCoordinates(1) is the Y coordinate
oCoordinates(2) is the Z coordinate
Example:
This example retrieves the coordinate of the point of NewMeasurable measure.
Dim Coordinates (2)
NewMeasurable.GetPoint Coordinates

Returns: tuple(float, float, float)

get_points_on_axis()¶

Note

CAA V5 Visual Basic help

Sub GetPointsOnAxis( CATSafeArrayVariant oCoordinates)

Retrieves the the characteristic points of the axis with respect of the size of the revolution object.
Parameters:
oCoordinates
The information of the characteristic points with respect to the product coordinate system:
oCoordinates(0) is the X coordinate of the centerpoint of the axis
oCoordinates(1) is the Y coordinate of the centerpoint of the axis
oCoordinates(2) is the Z coordinate of the centerpoint of the axis
oCoordinates(3) is the X coordinate of the startpoint of the axis
oCoordinates(4) is the Y coordinate of the startpoint of the axis
oCoordinates(5) is the Z coordinate of the startpoint of the axis
oCoordinates(6) is the X coordinate of the endpoint of the axis
oCoordinates(7) is the Y coordinate of the endpoint of the axis
oCoordinates(8) is the Z coordinate of the endpoint of the axis
Example:
This example retrieves the characteristic points of the axis of NewMeasurable measure.
Dim Coordinates (8)
NewMeasurable.GetPointsOnAxis Coordinates

Returns: tuple(float, float, float, float, float, float, float, float)

get_points_on_curve()¶

Note

CAA V5 Visual Basic help

Sub GetPointsOnCurve( CATSafeArrayVariant oCoordinates)

Retrieves the characteristic points of the curve : the start point, the middle point and the end point.
Parameters:
oCoordinates
The information of the characteristic points of the curve with respect to the product coordinate system:
oCoordinates(0) is the X coordinate of the startpoint of the curve
oCoordinates(1) is the Y coordinate of the startpoint of the curve
oCoordinates(2) is the Z coordinate of the startpoint of the curve
oCoordinates(3) is the X coordinate of the midpoint of the curve
oCoordinates(4) is the Y coordinate of the midpoint of the curve
oCoordinates(5) is the Z coordinate of the midpoint of the curve
oCoordinates(6) is the X coordinate of the endpoint of the curve
oCoordinates(7) is the Y coordinate of the endpoint of the curve
oCoordinates(8) is the Z coordinate of the endpoint of the curve
Example:
This example retrieves the characteristic points of the curve of NewMeasurable measure.
Dim Coordinates (8)
NewMeasurable.GetPointsOnCurve Coordinates

Returns: tuple(float, float, float, float, float, float, float, float)

property length¶

..note::

CAA V5 Visual Basic help

Property Length( ) As double (Read Only)

Returns the Length of a curve.

Example:

This example retrieves the Length of NewMeasurable measure.

Dim ALength As double

ALength = NewMeasurable.Length

Returns: float

property perimeter¶

Note

CAA V5 Visual Basic help

Property Perimeter( ) As double (Read Only)

Returns the perimeter of a surface.

Example:

This example retrieves the perimeter of NewMeasurable measure.

Dim APerimeter As double

APerimeter = NewMeasurable.Perimeter

Returns: float

property radius¶

..note ::

CAA V5 Visual Basic help

Property Radius( ) As double (Read Only)

Returns the radius of an arc, cylinder or sphere.

Example:

This example retrieves the Radius of NewMeasurable measure.

Dim ARadius As double

ARadius = NewMeasurable.Radius

Returns: float

property volume¶

..note::: CAA V5 Visual Basic help Property Volume( ) As double (Read Only)

Returns the volume.

Example:

This example retrieves the volume of NewMeasurable measure. The volume unit given by oVolume is m^3

Dim AVolume As double

AVolume = NewMeasurable.Volume

Returns: float

measure_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.measure_setting_att.MeasureSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Measurable

The interface to access a CATIAMeasurable Get measurements on the

object.

Two types of measurement can be done:

itself : gives dimensions related to the object itself (ex the radius of a circle).

between : gives dimensions related to another object (ex the distance between two products).

A restriction occurs for distance between: bodies (CATBody) cannot be measured.

Methods on VOLUME : GetVolume GetArea GetCOG

Methods on SURFACE : GetArea GetCOG GetPerimeter

Methods on PLANE : GetArea GetCOG GetPlane

Methods on CYLINDER : GetArea GetCOG GetAxis GetPointsOnAxis GetRadius

Methods on CONE : GetArea GetCOG GetAxis GetPointsOnAxis GetAngle

Methods on SPHERE : GetArea GetCOG GetRadius GetCenter

Methods on CURVE : GetLength GetCOG GetPointsOnCurve

Methods on LINE : GetLength GetCOG GetPointsOnCurve GetDirection

Methods on CIRCLE : GetLength GetCOG GetPointsOnCurve GetRadius GetCenter GetAngle GetAxis

Methods on POINT : GetPoint Methods on AXIS SYST : GetAxisSystem

property angle¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Angle() As double (Read Only)

Returns the Angle of a circle or cone.

Example:

This example retrieves the Angle of NewMeasurable

measure.

Dim AAngle As double

AAngle = NewMeasurable.Angle

Returns: float

property area¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Area() As double (Read Only)

Returns the area of the surface or wet area from volume.

Example:

This example retrieves the area of NewMeasurable

measure.

The area unit given by oArea is m²

Dim AArea As double

AArea = NewMeasurable.Area

Returns: float

property geometry_name¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GeometryName() As CatMeasurableName (Read Only)

Returns the name of the geometry of the measured object.

Example:

This example retrieves the name of the geometry of the

NewMeasurable measure.

Dim AGeometryName As CatMeasurableName

AGeometryName = NewMeasurable.GeometryName

Returns: enum cat_measurable_name

get_angle_between(i_measured_item=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetAngleBetween(Reference iMeasuredItem) As double

Compute the angle between the CATIAMeasurable and another.

Example:

This example retrieves the angle between the reference1 and

reference2.

Dim reference1 As Reference

Set reference1 = part1.CreateReferenceFromObject(object1)

Dim reference2 As Reference

Set reference2 = part1.CreateReferenceFromObject(object1)

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheMeasurable As Measurable

Set TheMeasurable = TheSPAWorkbench.GetMeasurable(reference1)

Dim MinimumDistance As double

MinimumDistance = TheMeasurable.GetAngleBetween(reference2)

Parameters: i_measured_item (Reference) –
Returns: float

get_axis(o_axis_vector=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetAxis(CATSafeArrayVariant oAxisVector)

Retrieves the axis vector of the cylinder or a cone.

Parameters:

oVector

The axis vector of the cylinder or a cone with respect to the

product coordinate system:

oAxisVector(0) is the X direction

oAxisVector(1) is the Y direction

oAxisVector(2) is the Z direction

Example:

This example retrieves the axis vector of the cylinder or a cone

of NewMeasurable measure.

Dim AxisVector (2)

NewMeasurable.GetAxis AxisVector

Parameters: o_axis_vector (tuple) –
Returns: None

get_axis_system(o_components=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetAxisSystem(CATSafeArrayVariant oComponents)

Retrieves the information of the axis system.

Parameters:

oCoordinates

The information of the axis system with respect to the product

coordinate system:

oComponents(0) is the X coordinate of the origin of the axis

system

oComponents(1) is the Y coordinate of the origin of the axis

system

oComponents(2) is the Z coordinate of the origin of the axis

system

oComponents(3) is the X coordinate of the first direction of

the axis system

oComponents(4) is the Y coordinate of the first direction of

the axis system

oComponents(5) is the Z coordinate of the first direction of

the axis system

oComponents(6) is the X coordinate of the second direction of

the axis system

oComponents(7) is the Y coordinate of the second direction of

the axis system

oComponents(8) is the Z coordinate of the second direction of

the axis system

oComponents(9) is the X coordinate of the third direction of

the axis system

oComponents(10) is the Y coordinate of the third direction of

the axis system

oComponents(11) is the Z coordinate of the third direction of

the axis system

Example:

This example retrieves information of the axis system of

NewMeasurable measure.

Dim Components (11)

NewMeasurable.GetAxisSystem Components

Parameters: o_components (tuple) –
Returns: None

get_center(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetCenter(CATSafeArrayVariant oCoordinates)

Retrieves the position of the center of a circle or

sphere.

Parameters:

oCoordinates

The position of the center with respect to the product coordinate

system:

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the position of the center of NewMeasurable

measure.

Dim Coordinates (2)

NewMeasurable.GetCOGPosition Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_cog(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetCOG(CATSafeArrayVariant oCoordinates)

Retrieves the position of the center of gravity of a surface and volume

.

Parameters:

oCoordinates

The position of the center of gravity with respect to the product

coordinate system:

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the position of the center of gravity of

NewMeasurable measure.

Dim Coordinates (2)

NewMeasurable.GetCOG Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_direction(o_direction=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetDirection(CATSafeArrayVariant oDirection)

Retrieves the direction of the line.

Parameters:

oDirection

The direction of the line with respect to the product coordinate

system:

oDirection(0) is the X direction

oDirection(1) is the Y direction

oDirection(2) is the Z direction

Example:

This example retrieves the direction of the line of NewMeasurable

measure.

Dim Direction (2)

NewMeasurable.GetDirection Direction

Parameters: o_direction (tuple) –
Returns: None

get_minimum_distance(i_measured_item=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetMinimumDistance(Reference iMeasuredItem) As double

Compute the minimum distance between the CATIAMeasurable and another.

Bodies (openbody, hybridbody..) cannot be measured

between.

Parameters:

oCoordinates

The information of the axis system with respect to the product

coordinate system:

oComponents(0) is the X coordinate of the origin of the axis

system

oComponents(1) is the Y coordinate of the origin of the axis

system

oComponents(2) is the Z coordinate of the origin of the axis

system

oComponents(3) is the X coordinate of the first direction of

the axis system

oComponents(4) is the Y coordinate of the first direction of

the axis system

oComponents(5) is the Z coordinate of the first direction of

the axis system

Example:

This example retrieves the distance between the reference1 and

reference2.

Dim reference1 As Reference

Set reference1 = part1.CreateReferenceFromObject(object1)

Dim reference2 As Reference

Set reference2 = part1.CreateReferenceFromObject(object1)

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheMeasurable As Measurable

Set TheMeasurable = TheSPAWorkbench.GetMeasurable(reference1)

Dim MinimumDistance As double

MinimumDistance = TheMeasurable.GetMinimumDistance(reference2)

Parameters: i_measured_item (Reference) –
Returns: float

get_minimum_distance_points(i_measured_item=None, o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetMinimumDistancePoints(Reference iMeasuredItem,

CATSafeArrayVariant oCoordinates)

Compute the points corresponding to the minimum distance between the two

references.

Example:

This example retrieves the points corresponding to the distance

between the reference1 and reference2.

Dim reference1 As Reference

Set reference1 = part1.CreateReferenceFromObject(object1)

Dim reference2 As Reference

Set reference2 = part1.CreateReferenceFromObject(object1)

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheMeasurable As Measurable

Set TheMeasurable = TheSPAWorkbench.GetMeasurable(reference1)

Dim Coordinates (8)

TheMeasurable.GetMinimumDistancePoints reference2,

Coordinates

Parameters

i_measured_item (Reference) –
o_coordinates (tuple) –

Returns

None

get_plane(o_components=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPlane(CATSafeArrayVariant oComponents)

Retrieves informations of the plane.

Parameters:

oComponents

The informations of the plane with respect to the product

coordinate system:

oComponents(0) is the X coordinate of the

origin

oComponents(1) is the Y coordinate of the

origin

oComponents(2) is the Z coordinate of the

origin

oComponents(3) is the X coordinate of the first direction of

the plane

oComponents(4) is the Y coordinate of the first direction of

the plane

oComponents(5) is the Z coordinate of the first direction of

the plane

oComponents(6) is the X coordinate of the second direction of

the plane

oComponents(7) is the Y coordinate of the second direction of

the plane

oComponents(8) is the Z coordinate of the second direction of

the plane

Example:

This example retrieves informations of the plane of NewMeasurable

measure.

Dim Components (2)

NewMeasurable.GetPlane Components

Parameters: o_components (tuple) –
Returns: None

get_point(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPoint(CATSafeArrayVariant oCoordinates)

Retrieves the position of the point.

Parameters:

oCoordinates

The coordinate of the point with respect to the product coordinate

system:

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the coordinate of the point of

NewMeasurable measure.

Dim Coordinates (2)

NewMeasurable.GetPoint Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_points_on_axis(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPointsOnAxis(CATSafeArrayVariant oCoordinates)

Retrieves the the characteristic points of the axis with respect of the

size of the revolution object.

Parameters:

oCoordinates

The information of the characteristic points with respect to the

product coordinate system:

oCoordinates(0) is the X coordinate of the centerpoint of the

axis

oCoordinates(1) is the Y coordinate of the centerpoint of the

axis

oCoordinates(2) is the Z coordinate of the centerpoint of the

axis

oCoordinates(3) is the X coordinate of the startpoint of the

axis

oCoordinates(4) is the Y coordinate of the startpoint of the

axis

oCoordinates(5) is the Z coordinate of the startpoint of the

axis

oCoordinates(6) is the X coordinate of the endpoint of the

axis

oCoordinates(7) is the Y coordinate of the endpoint of the

axis

oCoordinates(8) is the Z coordinate of the endpoint of the axis

Example:

This example retrieves the characteristic points of the axis of

NewMeasurable measure.

Dim Coordinates (8)

NewMeasurable.GetPointsOnAxis Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

get_points_on_curve(o_coordinates=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPointsOnCurve(CATSafeArrayVariant oCoordinates)

Retrieves the the characteristic points of the curve : the start point, the middle point and the

end point.

Parameters:

oCoordinates

The information of the characteristic points of the curve with

respect to the product coordinate system:

oCoordinates(0) is the X coordinate of the startpoint of the

curve

oCoordinates(1) is the Y coordinate of the startpoint of the

curve

oCoordinates(2) is the Z coordinate of the startpoint of the

curve

oCoordinates(3) is the X coordinate of the midpoint of the

curve

oCoordinates(4) is the Y coordinate of the midpoint of the

curve

oCoordinates(5) is the Z coordinate of the midpoint of the

curve

oCoordinates(6) is the X coordinate of the endpoint of the

curve

oCoordinates(7) is the Y coordinate of the endpoint of the

curve

oCoordinates(8) is the Z coordinate of the endpoint of the

curve

Example:

This example retrieves the characteristic points of the curve of

NewMeasurable measure.

Dim Coordinates (8)

NewMeasurable.GetPointsOnCurve Coordinates

Parameters: o_coordinates (tuple) –
Returns: None

property length¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Length() As double (Read Only)

Returns the Length of a curve.

Example:

This example retrieves the Length of NewMeasurable

measure.

Dim ALength As double

ALength = NewMeasurable.Length

Returns: float

property perimeter¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Perimeter() As double (Read Only)

Returns the perimeter of a surface.

Example:

This example retrieves the perimeter of NewMeasurable

measure.

Dim APerimeter As double

APerimeter = NewMeasurable.Perimeter

Returns: float

property radius¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Radius() As double (Read Only)

Returns the radius of an arc, cylinder or sphere.

Example:

This example retrieves the Radius of NewMeasurable

measure.

Dim ARadius As double

ARadius = NewMeasurable.Radius

Returns: float

property volume¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Volume() As double (Read Only)

Returns the volume.

Example:

This example retrieves the volume of NewMeasurable

measure.

The volume unit given by oVolume is m^3

Dim AVolume As double

AVolume = NewMeasurable.Volume

Returns: float

section¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.section.Section(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Section

Represents the Section object.

The Section object is a specification of a sectioning display and

computationwith a section plane, section slice or section box.

property annotated_views¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property AnnotatedViews() As AnnotatedViews (Read Only)

Returns the AnnotatedViews collection of the section.

Example:

This example retrieves the AnnotatedViews collection of NewSection

Section.

Dim TheAnnotatedViewsList As AnnotatedViews

Set TheAnnotatedViewsList = NewSection.AnnotatedViews

Returns: AnnotatedViews

property behavior¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Behavior() As CatSectionBehavior

Returns or sets the general behavior of the section: Freeze, Automatic

update, manual update

The behavior value are defined in CatSectionBehavior.

Example:

The first example retrieves the behavior of NewSection

Section.

Dim SectionBehavior As CatSectionBehavior

Behavior = NewSection.Behavior

The second example sets the behavior of NewSection

Section.

NewSection.Behavior = catSectionBehaviorAutomatic

Returns: enum cat_section_behavior

property cut_mode¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property CutMode() As long

Returns or sets the cutting mode of the section.

The cutting mode value is 1 for clipping or 0 without

clipping.

Example:

The first example retrieves the cutting mode of NewSection

Section.

Dim SectionMode As Integer

SectionMode = NewSection.CutMode

The second example sets the cutting mode of NewSection

Section.

NewSection.CutMode = 1

Returns: int

export()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Export() As Document

Exports the sections curves of the section in a document.

Returns:

The document

Example:

This example exports the section curves of NewSection Section in

PartDoc document.

Dim PartDoc As Document

PartDoc = NewSection.Export

Returns: Document

get_position(o_components=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPosition(CATSafeArrayVariant oComponents)

Retrieves the position of the section.

The position of the section is made of a coordinate system whose origin is

the center of the section, and X and Y axes lie on the section. It is retrieved

in an array of the X, Y, Z axes components and the origin components with

respect to the absolute coordinate system.

Parameters:

oComponents

The position of the section

oComponents( 0) is the X component of the

X-axis

oComponents( 1) is the Y component of the

X-axis

oComponents( 2) is the Z component of the

X-axis

oComponents( 3) is the X component of the

Y-axis

oComponents( 4) is the Y component of the

Y-axis

oComponents( 5) is the Z component of the

Y-axis

oComponents( 6) is the X component of the

Z-axis

oComponents( 7) is the Y component of the

Z-axis

oComponents( 8) is the Z component of the

Z-axis

oComponents( 9) is the X component of the

origin

oComponents(10) is the Y component of the

origin

oComponents(11) is the Z component of the origin

Example:

This example retrieves the position of NewSection

Section.

Dim Components (11)

NewSection.GetPosition Components

Parameters: o_components (tuple) –
Returns: None

property group¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Group() As Group

Returns or sets the sectionned group.

By default, it is the all leaves group.

Example:

The first example retrieves the group of NewSection

Section.

Dim AGroup As Group

AGroup = NewSection.Group

The second example sets the group of NewSection

Section.

Dim AGroup As Group

NewSection.Group = AGroup

Returns: Group

property height¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Height() As double

Returns or sets the height of the section.

The height value must be greater than 0.

Example:

The first example retrieves the height of NewSection

Section.

Dim SectionHeight As double

SectionHeight = NewSection.Height

The second example sets the height value of NewSection

Section.

NewSection.Height = 100.

Returns: float

is_empty()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func IsEmpty() As long

Indicates whether the section is empty.

The indicator value is 0 if the section is empty or 1 if the section

comprise at least one segment.

Example:

This example retrieves the information on NewSection

Section.

Dim Indicator

Indicator = NewSection.IsEmpty

Returns: int

property marker3_ds¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Marker3Ds() As Marker3Ds (Read Only)

Returns the Marker3Ds collection of the section.

Example:

This example retrieves the Marker3Ds collection of NewSection

Section.

Dim TheMarker3DsList As Marker3Ds

Set TheMarker3DsList = NewSection.Marker3Ds

Returns: Marker3Ds

set_position(i_components=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPosition(CATSafeArrayVariant iComponents)

Sets the position of the section.

Parameters:

oComponents

The position of the section with respect to the absolute coordinate

system

iComponents( 0) is the X component of the

X-axis

iComponents( 1) is the Y component of the

X-axis

iComponents( 2) is the Z component of the

X-axis

iComponents( 3) is the X component of the

Y-axis

iComponents( 4) is the Y component of the

Y-axis

iComponents( 5) is the Z component of the

Y-axis

iComponents( 6) is the X component of the

Z-axis

iComponents( 7) is the Y component of the

Z-axis

iComponents( 8) is the Z component of the

Z-axis

iComponents( 9) is the X component of the

origin

iComponents(10) is the Y component of the

origin

iComponents(11) is the Z component of the origin

Example:

This example sets the position of NewSection

Section.

Dim MatrixPos (11) As Double

MatrixPos( 0) = 1.0

MatrixPos( 1) = 0.0

MatrixPos( 2) = 0.0

MatrixPos( 3) = 0.0

MatrixPos( 4) = 1.0

MatrixPos( 5) = 0.0

MatrixPos( 6) = 0.0

MatrixPos( 7) = 0.0

MatrixPos( 8) = 1.0

MatrixPos( 9) = 1000.0

MatrixPos(10) = 0.0

MatrixPos(11) = 0.0

NewSection.SetPosition MatrixPos

Parameters: i_components (tuple) –
Returns

property thickness¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Thickness() As double

Returns or sets the thickness of the section.

The thickness value must be greater than 0.

Example:

The first example retrieves the thickness of NewSection

Section.

Dim SectionThickness As double

SectionThickness = NewSection.Thickness

The second example sets the thickness value of NewSection

Section.

NewSection.Thickness = 100.

Returns: float

property type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Type() As CatSectionType

Returns or sets the type of the section.

The type value are defined in CatSectionType.

Example:

The first example retrieves the type of NewSection

Section.

Dim SectionType As CatSectionType

SectionType = NewSection.Type

The second example sets the type of NewSection

Section.

NewSection.Type = catSectionTypeSlice

Returns: enum cat_section_type

property width¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Width() As double

Returns or sets the width of the section.

The width value must be greater than 0.

Example:

The first example retrieves the width of NewSection

Section.

Dim SectionWidth As double

SectionWidth = NewSection.Width

The second example sets the width value of NewSection

Section.

NewSection.Width = 100.

Returns: float

sectioning_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.sectioning_setting_att.SectioningSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

SectioningSettingAtt

The interface to access a CATIASectioningSettingAtt.

property clipping_mode¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ClippingMode() As CatSectionClippingMode

Returns or sets the ClippingMode parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: enum cat_section_clipping_mode

property display_cut_in_wireframe¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property DisplayCutInWireframe() As boolean

Returns or sets the DisplayCutInWireframe parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

get_clipping_mode_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetClippingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ClippingMode

parameter.

Role:Retrieves the state of the ClippingMode parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_display_cut_in_wireframe_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetDisplayCutInWireframeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisplayCutInWireframe

parameter.

Role:Retrieves the state of the DisplayCutInWireframe parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_grid_auto_filtering_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetGridAutoFilteringInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridAutoFiltering

parameter.

Role:Retrieves the state of the GridAutoFiltering parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_grid_auto_resize_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetGridAutoResizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridAutoResize

parameter.

Role:Retrieves the state of the GridAutoResize parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_grid_height_step_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetGridHeightStepInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridHeightStep

parameter.

Role:Retrieves the state of the GridHeightStep parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_grid_position_mode_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetGridPositionModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridPositionMode

parameter.

Role:Retrieves the state of the GridPositionMode parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_grid_style_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetGridStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridStyle

parameter.

Role:Retrieves the state of the GridStyle parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_grid_width_step_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetGridWidthStepInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the GridWidthStep

parameter.

Role:Retrieves the state of the GridWidthStep parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_hide_plane_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetHidePlaneInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the HidePlane

parameter.

Role:Retrieves the state of the HidePlane parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_hide_result_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetHideResultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the HideResult

parameter.

Role:Retrieves the state of the HideResult parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_plane_color(o_r=None, o_g=None, o_b=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPlaneColor(long oR,

long oG,

long oB)

Returns the PlaneColor parameter.

Parameters:

oR

the red component of the color.

oG

the green component of the color.

oB

the blue component of the color.

Ensure consistency with the C++ interface to which the work is

delegated.

Parameters

o_r (int) –
o_g (int) –
o_b (int) –

Returns

None

get_plane_color_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPlaneColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlaneColor

parameter.

Role:Retrieves the state of the PlaneColor parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_plane_normal_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPlaneNormalInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlaneNormal

parameter.

Role:Retrieves the state of the PlaneNormal parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_plane_origin_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPlaneOriginInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PlaneOrigin

parameter.

Role:Retrieves the state of the PlaneOrigin parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_section_export_type_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetSectionExportTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SectionExportType

parameter.

Role:Retrieves the state of the SectionExportType parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_section_fill_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetSectionFillInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SectionFill

parameter.

Role:Retrieves the state of the SectionFill parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_update_result_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetUpdateResultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the UpdateResult

parameter.

Role:Retrieves the state of the UpdateResult parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_viewer_auto_open_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetViewerAutoOpenInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewerAutoOpen

parameter.

Role:Retrieves the state of the ViewerAutoOpen parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_viewer_auto_reframe_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetViewerAutoReframeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewerAutoReframe

parameter.

Role:Retrieves the state of the ViewerAutoReframe parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_viewer_lock2_d_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetViewerLock2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewerLock2D

parameter.

Role:Retrieves the state of the ViewerLock2D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_window_default_height_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetWindowDefaultHeightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WindowDefaultHeight

parameter.

Role:Retrieves the state of the WindowDefaultHeight parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_window_default_width_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetWindowDefaultWidthInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WindowDefaultWidth

parameter.

Role:Retrieves the state of the WindowDefaultWidth parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

get_window_open_mode_info(io_admin_level=None, io_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetWindowOpenModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WindowOpenMode

parameter.

Role:Retrieves the state of the WindowOpenMode parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

io_admin_level (str) –
io_locked (str) –

Returns

bool

property grid_auto_filtering¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GridAutoFiltering() As boolean

Returns or sets the GridAutoFiltering parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property grid_auto_resize¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GridAutoResize() As boolean

Returns or sets the GridAutoResize parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property grid_height_step¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GridHeightStep() As float

Returns or sets the GridHeightStep parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: float

property grid_position_mode¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GridPositionMode() As CatGridPositionMode

Returns or sets the GridPositionMode parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: enum cat_grid_position_mode

property grid_style¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GridStyle() As CatSectionGridStyle

Returns or sets the GridStyle parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: enum cat_section_grid_style

property grid_width_step¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property GridWidthStep() As float

Returns or sets the GridWidthStep parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: float

property hide_plane¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property HidePlane() As boolean

Returns or sets the HidePlane parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property hide_result¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property HideResult() As boolean

Returns or sets the HideResult parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property plane_normal¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PlaneNormal() As CatSectionPlaneNormal

Returns or sets the PlaneNormal parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: enum cat_section_plane_normal

property plane_origin¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PlaneOrigin() As CatSectionPlaneOrigin

Returns or sets the PlaneOrigin parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: enum cat_section_plane_origin

property section_export_type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property SectionExportType() As boolean

Returns or sets the SectionExportType parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property section_fill¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property SectionFill() As boolean

Returns or sets the SectionFill parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

set_clipping_mode_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetClippingModeLock(boolean iLocked)

Locks or unlocks the ClippingMode parameter.

Role:Locks or unlocks the PlaneOrigin parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_display_cut_in_wireframe_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetDisplayCutInWireframeLock(boolean iLocked)

Locks or unlocks the DisplayCutInWireframe parameter.

Role:Locks or unlocks the DisplayCutInWireframe parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_grid_auto_filtering_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetGridAutoFilteringLock(boolean iLocked)

Locks or unlocks the GridAutoFiltering parameter.

Role:Locks or unlocks the GridAutoFiltering parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_grid_auto_resize_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetGridAutoResizeLock(boolean iLocked)

Locks or unlocks the GridAutoResize parameter.

Role:Locks or unlocks the GridAutoResize parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_grid_height_step_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetGridHeightStepLock(boolean iLocked)

Locks or unlocks the GridHeightStep parameter.

Role:Locks or unlocks the GridHeightStep parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_grid_position_mode_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetGridPositionModeLock(boolean iLocked)

Locks or unlocks the GridPositionMode parameter.

Role:Locks or unlocks the GridPositionMode parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_grid_style_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetGridStyleLock(boolean iLocked)

Locks or unlocks the GridStyle parameter.

Role:Locks or unlocks the GridStyle parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_grid_width_step_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetGridWidthStepLock(boolean iLocked)

Locks or unlocks the GridWidthStep parameter.

Role:Locks or unlocks the GridWidthStep parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_hide_plane_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetHidePlaneLock(boolean iLocked)

Locks or unlocks the HidePlane parameter.

Role:Locks or unlocks the HidePlane parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_hide_result_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetHideResultLock(boolean iLocked)

Locks or unlocks the HideResult parameter.

Role:Locks or unlocks the HideResult parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_plane_color(i_r=None, i_g=None, i_b=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPlaneColor(long iR,

long iG,

long iB)

Sets the PlaneColor parameter.

Parameters:

oR

the red component of the color.

oG

the green component of the color.

oB

the blue component of the color.

Ensure consistency with the C++ interface to which the work is

delegated.

Parameters

i_r (int) –
i_g (int) –
i_b (int) –

Returns

None

set_plane_color_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPlaneColorLock(boolean iLocked)

Locks or unlocks the PlaneColor parameter.

Role:Locks or unlocks the PlaneColor parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_plane_normal_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPlaneNormalLock(boolean iLocked)

Locks or unlocks the PlaneNormal parameter.

Role:Locks or unlocks the PlaneNormal parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_plane_origin_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPlaneOriginLock(boolean iLocked)

Locks or unlocks the PlaneOrigin parameter.

Role:Locks or unlocks the PlaneOrigin parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_section_export_type_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetSectionExportTypeLock(boolean iLocked)

Locks or unlocks the SectionExportType parameter.

Role:Locks or unlocks the SectionExportType parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_section_fill_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetSectionFillLock(boolean iLocked)

Locks or unlocks the SectionFill parameter.

Role:Locks or unlocks the SectionFill parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_update_result_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetUpdateResultLock(boolean iLocked)

Locks or unlocks the UpdateResult parameter.

Role:Locks or unlocks the UpdateResult parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_viewer_auto_open_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetViewerAutoOpenLock(boolean iLocked)

Locks or unlocks the ViewerAutoOpen parameter.

Role:Locks or unlocks the ViewerAutoOpen parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_viewer_auto_reframe_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetViewerAutoReframeLock(boolean iLocked)

Locks or unlocks the ViewerAutoReframe parameter.

Role:Locks or unlocks the ViewerAutoReframe parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_viewer_lock2_d_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetViewerLock2DLock(boolean iLocked)

Locks or unlocks the ViewerLock2D parameter.

Role:Locks or unlocks the ViewerLock2D parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_window_default_height_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetWindowDefaultHeightLock(boolean iLocked)

Locks or unlocks the WindowDefaultHeight parameter.

Role:Locks or unlocks the WindowDefaultHeight parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_window_default_width_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetWindowDefaultWidthLock(boolean iLocked)

Locks or unlocks the WindowDefaultWidth parameter.

Role:Locks or unlocks the WindowDefaultWidth parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

set_window_open_mode_lock(i_locked=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetWindowOpenModeLock(boolean iLocked)

Locks or unlocks the WindowOpenMode parameter.

Role:Locks or unlocks the WindowOpenMode parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters: i_locked (bool) –
Returns: None

property update_result¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property UpdateResult() As boolean

Returns or sets the UpdateResult parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property viewer_auto_open¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ViewerAutoOpen() As boolean

Returns or sets the ViewerAutoOpen parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property viewer_auto_reframe¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ViewerAutoReframe() As boolean

Returns or sets the ViewerAutoReframe parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property viewer_lock2_d¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property ViewerLock2D() As boolean

Returns or sets the ViewerLock2D parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Returns: bool

property window_default_height¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property WindowDefaultHeight() As long

Role:Retrieve section window default height if the window open mode is

catSecWindow_DefaultSize

Parameters:

oWindowDefaultHeight

Returns:

S_OK Successfully retieved the window open mode E_FAIL Failed to

retrieved the window open mode

Returns: int

property window_default_width¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property WindowDefaultWidth() As long

Role:Retrieve section window default width if the window open mode is

catSecWindow_DefaultSize

Parameters:

oWindowDefaultWidth

Returns:

S_OK Successfully retieved the window open mode E_FAIL Failed to

retrieved the window open mode

Returns: int

property window_open_mode¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property WindowOpenMode() As CatSecWindowOpenMode

Role:Retrieve section window open mode

Parameters:

oWindowOpenMode

Legal values:

catSecWindow_DefaultSize :Opens the sectioning window(s) with the

default size specified in the Tools->Options.

catSecWindow_TileVertically :Tiles the sectioning window(s)

vertically in the viewer

Returns:

S_OK Successfully retieved the window open mode E_FAIL Failed to

retrieved the window open mode

Returns: enum cat_sec_window_open_mode

sections¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.sections.Sections(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Sections

A collection of all Section objects currently managed by the

application.

The method GetTechnologicalObject(“Sections”) on the root product, allows you

to retrieve this collection.

add()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Add() As Section

Creates a Section object which takes all products of the documents into

account and adds it to the Sections collection.

Returns:

The created Section

Example:

This example creates a new Section in the TheSections

collection.

Dim NewSection As Section

Set NewSection = TheSections.Add

Returns: Section

add_from_sel()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func AddFromSel() As Section

Creates a Section object which takes all products in the selection into

account and adds it to the Sections collection.

Returns:

The created Section

Example:

This example creates a new Section in the TheSections

collection.

Dim NewSection As Section

Set NewSection = TheSections.AddFromSel

Returns: Section

item(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func Item(CATVariant iIndex) As Section

Returns a Section object using its index or its name from the Sections

collection.

Parameters:

iIndex

The index or the name of the Section to retrieve from the

collection of Sections. As a numerics, this index is the rank of the Section in

the collection. The index of the first Section in the collection is 1, and the

index of the last Section is Count. As a string, it is the name you assigned to

the Section.

Example:

This example retrieves in ThisSection the ninth

Section,

and in ThatSection the Section named

Section Of MyProduct from the TheSections collection.

Dim ThisSection As Section

Set ThisSection = TheSections.Item(9)

Dim ThatSection As Section

Set ThatSection = TheSections.Item(“Section Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: Section

remove(i_index=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub Remove(CATVariant iIndex)

Removes a Section object from the Sections collection.

Parameters:

iIndex

The index or the name of the Section to remove from the collection

of Sections. As a numerics, this index is the rank of the Section in the

collection. The index of the first Section in the collection is 1, and the

index of the last Section is Count. As a string, it is the name you assigned to

the Section.

Example:

The following example removes the tenth Section and the Section

named

Section Of MyProduct from the TheSections

collection.

TheSections.Remove(10)

TheSections.Remove(“Section Of MyProduct”)

Parameters: i_index (CATVariant) –
Returns: None

spa_workbench¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.space_analyses_interfaces.spa_workbench.SPAWorkbench(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

InfInterfaces.Workbench

SPAWorkbench

The object to manage all Space Analysis objects.

This version allows you to manage inertia data, clashes, distances and

sections.

property clashes¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Clashes() As Clashes (Read Only)

Returns the Clashes collection.

WARNING: this method will be DEPRECATED in the next release. It is

recommended to use the method GetTechnologicalObject(“Clashes”) on the root

product, to retrieve the Clashes collection.

Example:

This example retrieves the Clashes collection of the active

document.

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheClashesList As Clashes

Set TheClashesList = TheSPAWorkbench.Clashes

Returns: Clashes

property distances¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Distances() As Distances (Read Only)

Returns the Distances collection.

WARNING: this method will be DEPRECATED in the next release. It is

recommended to use the method GetTechnologicalObject(“Distances”) on the root

product, to retrieve the Distances collection.

Example:

This example retrieves the Distances collection of the active

document.

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheDistancesList As Distances

Set TheDistancesList = TheSPAWorkbench.Distances

Returns: Distances

get_measurable(i_measured_item=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetMeasurable(Reference iMeasuredItem) As Measurable

Returns the Measurable object.

Example:

This example get the Measurable from the

SPAWorkBench.

Dim referenceObject As referenceObject

Set referenceObject = “GetReference”

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheMeasurable As Measurable

Set TheMeasurable = TheSPAWorkbench.GetMeasurable(referenceObject)

Parameters: i_measured_item (Reference) –
Returns: Measurable

property inertias¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Inertias() As Inertias (Read Only)

Returns the Inertias collection.

WARNING: this method will be DEPRECATED in the next release. It is

recommended to use the method GetTechnologicalObject(“Inertia”) on the product

to analyze, to retrieve an Inertia object.

Example:

This example retrieves the Inertias collection of the active

document.

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheInertiasList As Inertias

Set TheInertiasList = TheSPAWorkbench.Inertias

Returns: Inertias

property sections¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property Sections() As Sections (Read Only)

Returns the Sections collection.

WARNING: this method will be DEPRECATED in the next release. It is

recommended to use the method GetTechnologicalObject(“Sections”) on the root

product, to retrieve the Sections collection.

Example:

This example retrieves the Sections collection of the active

document.

Dim TheSPAWorkbench As Workbench

Set TheSPAWorkbench = CATIA.ActiveDocument.GetWorkbench ( “SPAWorkbench” )

Dim TheSectionsList As Sections

Set TheSectionsList = TheSPAWorkbench.Sections

Returns: Sections