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

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: AnnotatedViews

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

AnnotatedViews

property clearance: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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.
Return type:

float

property computation_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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

Return type:

int

compute() → None

Note

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

Computes the conflicts.

Example:

This example computes the conflicts of NewClash
Clash.

NewClash.Compute
Return type:

None

property conflicts: Conflicts

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Conflicts

export(i_type: int, i_path: str) → 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 (int) – enum cat_clash_export_type

  • i_path (str) –

Return type:

None

property first_group: Group

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Group

property interference_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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

Return type:

int

property marker_3ds: Marker3Ds

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Marker3Ds

property second_group: Group

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
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
Return type:

Group