pycatia.cat_tps_interfaces.annotation_2

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_2.Annotation2(com_object)

Introduced in V5-6R2017.

Note

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

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Annotation2

Interface for the Technological Product Specification (TPS)

objects.

Leaf entity in the Design Pattern Composite. TPS modeler enables definition of

specification related to surfaces.

add_leader() → None

Note

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

o Sub AddLeader()

Add a leader.

Return type:

None

coordinate_dimension() → CoordDim

Introduced in V5-6R2018.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func Coordinatedimension() As CoordDim

Retrieves the FTA co coordinate dimension.

Return type:

CoordDim

datum_simple() → DatumSimple

Note

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

o Func DatumSimple() As DatumSimple

Gets the annotation on the DatumSimple interface.

Return type:

DatumSimple

datum_target() → DatumTarget

Note

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

o Func DatumTarget() As DatumTarget

Gets the annotation on the DatumTarget interface.

Return type:

DatumTarget

default_annotation() → DefaultAnnotation

Note

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

o Func DefaultAnnotation() As DefaultAnnotation

Gets the annotation on the DefaultAnnotation interface.

Return type:

DefaultAnnotation

dimension_3d() → Dimension3D

Note

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

o Func Dimension3D() As Dimension3D

Gets the 3D Dimension on the 3D Dimension interface.

Parameters:

oDim

The 3D Dimension.

Return type:

Dimension3D

flag_note() → FlagNote

Note

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

o Func FlagNote() As FlagNote

Gets the annotation on the FlagNote interface.

Parameters:

oFlagNote

The annotation Flag Note.

Return type:

FlagNote

get_geometrical_component_name(i_index: int) → str

Introduced in V5-6R2022.

Note

CAA V5 Visual Basic Help (2026-02-21 15:26:49.309967)

Func GetGeometricalComponentName(short iIndex) As CATBSTR

Gets the Geometrical Component name at given index.

Parameters:

iIndex

The index of the geometrical component; this value is greater or

equal to 1 and lower or equal to the value returned by

GetNbrOfGeometricalComponent.

oComponentName

The name of the geometrical component.

Parameters:

i_index (int) –

Return type:

str

get_nbr_of_geometrical_component() → int

Introduced in V5-6R2022.

Note

CAA V5 Visual Basic Help (2026-02-21 15:26:49.309967)

Func GetNbrOfGeometricalComponent() As short

Gets the number of geometrical components.

Parameters:

oGeomLinkNbr

The number of links to the geometry employed by this

annotation.

The returned value is comprise in between 1 and N (N is at most the

total of geometrical links existing under the

annotation).

The amount of Geometrical Component sent back may be different from

the annotation total links to the geometry because

sometimes

the Group of Surfaces may point to the same geometrical component

participating to the definition of several User Surfaces.

Return type:

int

get_surfaces(o_safe_array: tuple) → None

Note

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

o Sub GetSurfaces(CATSafeArrayVariant oSafeArray)

Gets the geometry on which the Annotation is applied to.

Parameters:

o_safe_array (tuple) –

Return type:

None

get_surfaces_count() → int

Note

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

o Func GetSurfacesCount() As long

Counts the geometry on which the Annotation is applied to.

Return type:

int

has_a_visualization_dimension() → bool

Note

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

o Func HasAVisualizationDimension() As boolean

Checks if the Annotation uses a visualization dimension for its attachment

to the geometry.

Return type:

bool

is_a_consumable_annotation() → bool

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func IsAConsumableAnnotation() As boolean

Checks if the Annotation is a Consumable Annotation.

Return type:

bool

is_a_default_annotation() → bool

Note

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

o Func IsADefaultAnnotation() As boolean

To know if the Annotation is a Default Annotation.

Return type:

bool

modify_visu() → None

Note

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

o Sub ModifyVisu()

To refresh the 3D visualization.

Return type:

None

noa() → Noa

Note

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

o Func Noa() As Noa

Gets the annotation on the Noa interface.

Return type:

Noa

non_semantic_datum() → NonSemanticDatum

Note

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

o Func NonSemanticDatum() As NonSemanticDatum

Gets the annotation on the DatumSimple interface.

Return type:

NonSemanticDatum

non_semantic_datum_target() → NonSemanticDatumTarget

Note

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

o Func NonSemanticDatumTarget() As NonSemanticDatumTarget

Gets the annotation on the DatumSimple interface.

Return type:

NonSemanticDatumTarget

non_semantic_dimension() → NonSemanticDimension

Note

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

o Func NonSemanticDimension() As NonSemanticDimension

Gets the annotation on the DatumSimple interface.

Return type:

NonSemanticDimension

non_semantic_gdt() → NonSemanticGDT

Note

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

o Func NonSemanticGDT() As NonSemanticGDT

Gets the annotation on the DatumSimple interface.

Return type:

NonSemanticGDT

reference_frame() → ReferenceFrame

Note

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

o Func ReferenceFrame() As ReferenceFrame

Gets the annotation on the ReferenceFrame interface.

Return type:

ReferenceFrame

roughness() → Roughness

Note

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

o Func Roughness() As Roughness

Gets the annotation on the Roughness interface.

Return type:

Roughness

semantic_gdt() → SemanticGDT

Note

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

o Func SemanticGDT() As SemanticGDT

Gets the annotation on the DatumSimple interface.

Return type:

SemanticGDT

set_geometrical_component_name(i_index: int, i_new_name: str, i_check_name_unicity_option: bool) → None

Introduced in V5-6R2022.

Note

CAA V5 Visual Basic Help (2026-02-21 15:26:49.309967)

Sub SetGeometricalComponentName(short iIndex,CATBSTR iNewName,boolean

iCheckNameUnicityOption)

Sets the Geometrical Component name at given index.

Parameters:

iIndex

The index of the geometrical component; this value is greater or

equal to 1 and lower or equal to the value returned by

GetNbrOfGeometricalComponent.

The user is allowed to pass a 0 value as index; in this case, an

automatic renaming is triggered.

In this case the usual path of a geometrical component (for

instance Face/Name of the feature/Body.1) is used to extract the logical name

to apply “Name of the feature”.

Pay attention that geometrical component name must be unique; this

method is exiting in error whenever the unicity is of geometrical component is

broken.

The renaming processing is given up without any change when an

already existing name is passed to this method or when automatic processing

faces naming ambiguity.

iNewName

The string used to rename the geometrical component.

iCheckNameUnicityOption

Option to trigger an addition verification during renaming to

guarantee that the entire set of Geometrical Components in the

representation

have a different name.

Parameters:

• i_index (int) –

• i_new_name (str) –

• i_check_name_unicity_option (bool) –

Return type:

None

set_xy(i_x: float, i_y: float) → None

Note

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

o Sub SetXY(double iX,

double iY)

method GetXY will never be exposed Set TPS coordinates in the

view

Parameters:

oX

The X coordinate.

oY

The Y coordinate.

Parameters:

• i_x (float) –

• i_y (float) –

Return type:

None

property super_type: str

Note

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

o Property SuperType() As CATBSTR (Read Only)

Gets the Super Type.

Parameters:

oSuperType

The Super Type. The list of SuperType available: “FTA_NonSemantic”

“FTA_Form” “FTA_Dimension” “FTA_Position” “FTA_Datum” “FTA_Orientation”

“FTA_RunOut”

Return type:

str

text() → Text

Note

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

o Func Text() As Text

Gets the annotation on the Text interface.

Parameters:

oText

The annotation Text.

Return type:

Text

property tps_status: str

Note

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

o Property TPSStatus() As CATBSTR (Read Only)

Gets the TPS Status.

Parameters:

oStatus

The Status.

Return type:

str

transfert_to_view(i_view: TPSView) → None

Note

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

o Sub TransfertToView(TPSView iView)

Move the annotation in another view.

Parameters:

iView

The destination view.

Parameters:

i_view (TPSView) –

Return type:

None

property type: str

Note

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

o Property Type() As CATBSTR (Read Only)

Gets the Type.

Parameters:

oType

The Type. List of types available ordered by SuperType: SuperType = “FTA_NonSemantic” Type = “FTA_Text” Type = “FTA_FlagNote” Type = “FTA_Roughness” Type = “FTA_Weld” Type = “FTA_Noa” Type = “FTA_NonSemanticDatum” Type = “FTA_NonSemanticTarget” Type = “FTA_NonSemanticGDT” Type = “FTA_NonSemanticDimension” SuperType = “FTA_Form” Type = “FTA_Flatness” Type = “FTA_Straightness” Type = “FTA_Circularity” Type = “FTA_Cylindricity” Type = “FTA_ProfileOfAnyLine” Type = “FTA_ProfileOfASurface” Type = “FTA_PatternTruePos” SuperType = “FTA_Dimension” Type = “FTA_LinearDimension” Type = “FTA_AngularDimension” Type = “FTA_SecondLinearDimension” Type = “FTA_ChamferDimension” Type = “FTA_BasicDimension” SuperType = “FTA_Position” Type = “FTA_TruePosition” Type = “FTA_Concentricity” Type = “FTA_Symmetry” Type = “FTA_PositionOfAnyLine” Type = “FTA_PositionOfASurface” SuperType = “FTA_Datum” Type = “FTA_DatumSimple” Type = “FTA_DatumTarget” Type = “FTA_DatumSystem” Type = “FTA_ReferenceFrame” SuperType = “FTA_Orientation” Type = “FTA_Parallelism” Type = “FTA_Perpendicularity” Type = “FTA_Angularity” SuperType = “FTA_RunOut” Type = “FTA_TotalRunOut” Type = “FTA_CircularRunOut”

Return type:

str

visualization_dimension() → Dimension3D

Note

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

o Func VisualizationDimension() As Dimension3D

Gets the dimension visualization associated with the

annotation.

Parameters:

oDim

The visualization Dimension oDim employed by the annotation to

display its link to the geometry.

Return type:

Dimension3D

weld() → Weld

Note

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

o Func Weld() As Weld

Gets the annotation on the Weld interface.

Return type:

Weld

property z: float

Note

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

o Property Z(double iZ) (Write Only)

method get_Z will never be exposed Set the offset of the

annotation

Parameters:

iZ

The offset.

Return type:

float