pycatia.in_interfaces.reference

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.in_interfaces.reference.Reference(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

Reference

Represents an object pointing to another object.

This other object can be either a wireframe GeometricElement object such as a

plane or a line, or a boundary representation object such as a face, a vertex

or an edge. It may be, in particular, a Boundary object. References are created

using appropriate methods for parts. They are then passed to an object to

enable associativity with the referenced object.

compose_with(i_reference: Reference) → Reference

Note

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

o Func ComposeWith(Reference iReference) As Reference

Composes a reference with another reference thus creating a new composite

reference.

Parameters:

iReference

The reference to be composed with the current

reference.

Example:

The following example returns in CompositeRef the reference

resulting from the composition of the FirstRef and SecondRef

references.

Dim CompositeRef As Reference

Set CompositeRef = FirstRef.ComposeWith(SecondRef)

Parameters:

i_reference (Reference) –

Return type:

Reference

property display_name: str

Note

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

o Property DisplayName() As CATBSTR (Read Only)

Returns the name of the referenced object. The name of the referenced

object is either the name displayed in the specification tree for a

GeometricElement object or a character string defining the reference for a

boundary object.

Example:

The following example returns in StrName the displayable name of

reference FirstRef:

StrName = FirstRef.DisplayName

Return type:

str