pycatia.space_analyses_interfaces.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-07-06 14:02:20.222384)

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-07-06 14:02:20.222384)

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

Return type

str

property comparison_info

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

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

int

Return type

int

property first_product

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

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

Return type

Product

get_first_point_coordinates() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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

Returns

tuple

Return type

tuple

get_second_point_coordinates() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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

Returns

tuple

Return type

tuple

property second_product

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

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

Return type

Product

property status

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

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

int

Return type

int

property type

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

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

int

Return type

int

property value

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

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

Return type

float