pycatia.cat_tps_interfaces.annotation_set

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_tps_interfaces.annotation_set.AnnotationSet(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
AnnotationSet

Interface for the TPS Set of objects.
property active_view: TPSView

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ActiveView() As TPSView

Gets or Sets Annotation Set ActiveView.

Parameters:

oView
Value of CATIATPSView.
Return type:

TPSView

property an_empty_annotations_list: Annotations

Note

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

Retrieves an empty Annotations’Collection.

Parameters:

oAnnots
Empty Annotations’ Collection.
Return type:

Annotations

property annotation_factory: AnnotationFactory

Note

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

Obtain the factory to create annotations.

Parameters:

oAFact
Annotations’ factory.
Return type:

AnnotationFactory

property annotation_factory_2: AnnotationFactory2

Note

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

Obtain the factory to create annotations.

Parameters:

oAFact
Annotations’ factory.
Return type:

AnnotationFactory2

property annotation_set_type: int

Note

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

Get the annotation Set type.

Parameters:

oAnnotationSetType
Value of Set Type.
Returns:

enum cat_annotation_set_type

Return type:

int

property annotations: Annotations

Note

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

Retrieves the TPS components of the set.

Parameters:

oAnnots
Collection of returned component.
Return type:

Annotations

apply_view_re_use_when_copy_set_to() → None

Note

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

Register for next call to either GlobalCopySetTo and like
methods.

See also:
CATIAAnnotationSet#GlobalCopySetTo or CATIAAnnotationSet, they are
placed in existing Views. This call sets an option valid for the next import
run only; in other words, this option is reset at the end of import. When
activated, this option will not break the import processing; if no View in
target set can receive a candidate FTA entity resulting from the import,
regular handling is carried on
Return type:

None

property capture_factory: CaptureFactory

Note

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

Obtain the factory to create Capture.

Parameters:

opiCapFact
Capture factory.
Return type:

CaptureFactory

property captures: Captures

Note

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

Retrieves all the Captures that belong to the set.

Parameters:

oCaptures
Collection of returned Captures.
Return type:

Captures

global_copy_set_to(i_destination_part: Part) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GlobalCopySetTo(Part iDestinationPart) As CATBSTR

Copies the entire or a subpart of a part level Annotation Set into a
destination CATPart

Parameters:

iDestinationPart
destination CATPart.
oMessage
result of datums merge.
Parameters:

i_destination_part (Part) –

Return type:

str

global_copy_set_to_with_transformation(i_destination_part: Part, i_transfo: tuple) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GlobalCopySetToWithTransformation(Part
iDestinationPart,
CATSafeArrayVariant iTransfo) As CATBSTR

Copies the entire Annotation Set into a destination
CATPart

Parameters:

iDestinationPart
destination CATPart.
iTransfo
Optional argument. Transformation matrix to apply to FTA features
during copy. The transformation is also used for retrieving in the destination
CATPart the geometrical elements the FTA features are rerouted on.
Transformation matrix is composed by a matrix3x3 and a translation vector:
[[a11 a12 a13 a21 a22 a23 a31 a32 a33] [u1 u2 u3]] a11 is in iTransfo(0) a12 is
in iTransfo(1) a13 is in iTransfo(2) a21 is in iTransfo(3) a22 is in
iTransfo(4) a23 is in iTransfo(5) a31 is in iTransfo(6) a32 is in iTransfo(7)
a33 is in iTransfo(8) u1 is in iTransfo(9) u2 is in iTransfo(10) u3 is in
iTransfo(11)
oMessage
result of datums merge.
Parameters:

  • i_destination_part (Part) –

  • i_transfo (tuple) –

Return type:

str

property kind_of_set: str

Note

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

Give the kind of set (Part, Product…).

Parameters:

oKindOfSet
It could be : Part Product Product_TP Process_BB Cgr Cgr_TP.
Return type:

str

property standard: str

Note

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

Retrieves the Parent Standard defined at set creation.

Parameters:

oStandard
Name of the Parent Standard applied for all TPS in the set. The
Parent Standard is the international standard on which Standard File is based
on. It can only be ISO, ANSI and JIS. (ANSI stands for
ASME).
Return type:

str

property switch_on: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SwitchOn() As boolean

Gets or Sets Annotation Set Visualization.

Parameters:

oDisplay
Value of visualisation mode.
Return type:

bool

property tps_view_factory: TPSViewFactory

Note

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

Obtain the factory to create TPS Views.

Parameters:

oTPSViewFact
TPS Views’ factory.
Return type:

TPSViewFactory

property tps_views: TPSViews

Note

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

Retrieves all the TPSViews that belong to the set.

Parameters:

oViews
Collection of returned views.
Return type:

TPSViews