pycatia.cat_tps_interfaces.annotation¶

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.Annotation(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

Annotation

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

apply_referenced_geom_colour(i_releated_r: int, i_releated_g: int, i_releated_b: int) → None¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Sub ApplyReferencedGeomColor(long iReleatedR,

long iReleatedG,

long iReleatedB)

Apply a color to referenced geometry.

Parameters:

i_releated_r (int) –
i_releated_g (int) –
i_releated_b (int) –

Return type:

None

apply_referenced_init_colour() → None¶

Note

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

Apply the initial color to referenced geometry.

Return type:: None

associated_ref_frame() → AssociatedRefFrame¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func AssociatedRefFrame() As AssociatedRefFrame

Get the annotation on the AssociatedRefFrame interface.

Return type:: AssociatedRefFrame

composite_tolerance() → CompositeTolerance¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func CompositeTolerance() As CompositeTolerance

Get the annotation on the CompositeTolerance interface.

Return type:: CompositeTolerance

controlled_radius() → ControlledRadius¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ControledRadius() As ControledRadius

Get the annotation on the ControledRadius interface.

Return type:: ControledRadius

datum_simple() → DatumSimple¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func DatumSimple() As DatumSimple

Get 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

Get 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

Get 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

Get the 3D Dimension on the 3D Dimension interface.

Parameters:

oDim

The 3D Dimension.

Return type:: Dimension3D

dimension_limit() → DimensionLimit¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func DimensionLimit() As DimensionLimit

Get the annotation on the DimensionLimit interface.

Return type:: DimensionLimit

dimension_pattern() → DimensionPattern¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func DimensionPattern() As DimensionPattern

Get the annotation on the DimensionPattern interface.

Return type:: DimensionPattern

envelop_condition() → EnvelopeCondition¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func EnvelopCondition() As EnvelopCondition

Get the annotation on the EnvelopCondition interface.

Return type:: EnvelopCondition

flag_note() → FlagNote¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func FlagNote() As FlagNote

Get the annotation on the FlagNote interface.

Parameters:

oFlagNote

The annotation Flag Note.

Return type:: FlagNote

free_state() → FreeState¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func FreeState() As FreeState

Get the annotation on the FreeState interface.

Return type:: FreeState

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) → tuple¶

Note

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

Get the geometry on which the Annotation is applied to.

Parameters:: o_safe_array (tuple) –
Return type:: tuple

get_surfaces_count() → float¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func GetSurfacesCount() As double

Count the geometry on which the Annotation is applied to.

Return type:: float

has_a_controlled_radius() → bool¶

Note

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

To know if the Annotation has a Controled Radius.

Return type:: bool

has_a_free_state() → bool¶

Note

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

To know if the Annotation has a Free State.

Return type:: bool

has_a_material_condition() → bool¶

Note

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

To know if the Annotation has a Material Condition.

Return type:: bool

has_a_numerical_display_format() → bool¶

Introduced in V5-6R2019.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445): Func HasANumericalDisplayFormat() As boolean

Checks if the Annotation has a Numerical Display Format.

Return type:: bool

has_a_particular_tol_elem() → bool¶

Note

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

To know if the Annotation has a Particuler Element.

Return type:: bool

has_a_tolerance_per_unit_basis_restrictive_value() → bool¶

Note

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

To know if the Annotation has a Tolerance Per Unit Basis Restricted Value.

Return type:: bool

has_an_envelop_condition() → bool¶

Note

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

To know if the Annotation has an Envelop Condition.

Return type:: bool

has_dimension_limit() → bool¶

Note

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

To know if the Annotation has a Dimension Limit.

Return type:: bool

is_a_composite_tolerance() → bool¶

Note

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

To know if the Annotation is a composite Tolerance.

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

is_a_dimension_pattern() → bool¶

Note

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

To know if the Annotation is a Dimension Pattern.

Return type:: bool

is_a_projected_tolerance_zone() → bool¶

Note

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

To know if the Annotation is a Projected Zone.

Return type:: bool

is_a_shifted_profile_tolerance() → bool¶

Note

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

To know if the Annotation is a Shifted Profile Tolerance.

Return type:: bool

is_a_tangent_plane() → bool¶

Note

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

To know if the Annotation is a Tangent Plane.

Return type:: bool

is_a_tolerance_unit_basis_value() → bool¶

Note

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

To know if the Annotation is a Tolerance Unit Basis Value.

Return type:: bool

is_a_tolerance_zone() → bool¶

Note

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

Is the a Tolerance Zone.

Return type:: bool

is_an_associated_ref_frame() → bool¶

Note

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

To know if the Annotation is an Associated Reference Frame.

Return type:: bool

material_condition() → MaterialCondition¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func MaterialCondition() As MaterialCondition

Get the annotation on the MaterialCondition interface.

Return type:: MaterialCondition

modify_visualisation() → 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

Get the annotation on the Noa interface.

Return type:: Noa

numerical_display_format() → NumericalDisplayFormat¶

Introduced in V5-6R2019.

Note

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

Gets the annotation on the NumericalDisplayFormat interface.

Return type:: NumericalDisplayFormat

particular_tol_elem() → ParticularTolElem¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ParticularTolElem() As ParticularTolElem

Get the annotation on the ParticularTolElem interface.

Return type:: ParticularTolElem

projected_tolerance_zone() → ProjectedToleranceZone¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ProjectedToleranceZone() As ProjectedToleranceZone

Get the annotation on the ProjectedToleranceZone interface.

Return type:: ProjectedToleranceZone

reference_frame() → ReferenceFrame¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ReferenceFrame() As ReferenceFrame

Get 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

Get the annotation on the Roughness interface.

Return type:: Roughness

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

shifted_profile_tolerance() → ShiftedProfileTolerance¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ShiftedProfileTolerance() As ShiftedProfileTolerance

Get the annotation on the ShiftedProfileTolerance interface.

Return type:: ShiftedProfileTolerance

property super_type: str¶

Note

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

Get 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

tangent_plane() → TangentPlane¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func TangentPlane() As TangentPlane

Get the annotation on the TangentPlane interface.

Return type:: TangentPlane

text() → Text¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func Text() As Text

Get the annotation on the Text interface.

Parameters:

oText

The annotation Text.

Return type:: Text

tolerance_per_unit_basis_restrictive_value() → TolerancePerUnitBasisRestrictiveValue¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func TolerancePerUnitBasisRestrictiveValue() As

TolerancePerUnitBasisRestrictiveValue

Get the annotation on the TolerancePerUnitBasisRestrictiveValue interface.

Return type:: TolerancePerUnitBasisRestrictiveValue

tolerance_unit_basis_value() → ToleranceUnitBasisValue¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ToleranceUnitBasisValue() As ToleranceUnitBasisValue

Get the annotation on the ToleranceUnitBasisValue interface.

Return type:: ToleranceUnitBasisValue

tolerance_zone() → ToleranceZone¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357): o Func ToleranceZone() As ToleranceZone

Get the annotation on the ToleranceZone interface.

Return type:: ToleranceZone

property tps_status: str¶

Note

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

Get 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)

Get 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

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

pycatia.cat_tps_interfaces.annotation¶

Navigation

Related Topics