pycatia.cat_tps_interfaces.annotation_factory

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_factory.AnnotationFactory(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

MecModInterfaces.Factory

AnnotationFactory

Interface for the TPS Factory.

This factory is implemented on the Set object. All the created specifications

are added to the Set from which this interface is retrieved.

create_datum(i_surf: UserSurface) → Annotation

Note

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

o Func CreateDatum(UserSurface iSurf) As Annotation

Create a Datum Feature.

Parameters:

iSurf

User surface needed to construct the Datum Feature.

oDatum

The new created Datum Feature.

Parameters:

i_surf (UserSurface) –

Return type:

Annotation

create_datum_reference_frame() → Annotation

Note

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

o Func CreateDatumReferenceFrame() As Annotation

Create a Reference Frame (DRF). iType = 1 : Straightness 2 : AxisStraightness 3 : Flatness 4 : Circularity 5 : Cylindricity 6 : ProfileOfALine 7 : ProfileOfASurface 8 : Position

Return type:

Annotation

create_datum_target(i_surf: UserSurface, i_datum: Annotation) → Annotation

Note

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

o Func CreateDatumTarget(UserSurface iSurf,

Annotation iDatum) As Annotation

Create a Datum Target.

Parameters:

iSurf

User surface needed to construct the Datum Target.

iDatum

Datume Feature that is in relatino with the Datum Target.

oDatum

The new created Datum Target.

Parameters:

• i_surf (UserSurface) –

• i_datum (Annotation) –

Return type:

Annotation

create_evaluate_datum(i_surf: UserSurface, i_x: float, i_y: float, i_z: float, i_with_leader: bool) → Annotation

Note

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

o Func CreateEvoluateDatum(UserSurface iSurf,

double iX,

double iY,

double iZ,

boolean iWithLeader) As Annotation

Create a Datum Feature.

Parameters:

iSurf

User surface needed to construct the Datum Feature.

iX

X coordinate.

iY

Y coordinate.

iZ

Z coordinate.

iWithLeader

Create or not a leader on the annotation. If the leader is

requested: The activated TPSView shall not be parallel to the surface pointed

by the annotation Datum. If the activated TPSView is parallel to the surface

pointed: - The leader will be disconnected - The extremity of the leader will

be positioned at the origin of the part - The annotation Datum is created but

its status will be KO.

oDatum

The new created Datum Feature.

Parameters:

• i_surf (UserSurface) –

• i_x (float) –

• i_y (float) –

• i_z (float) –

• i_with_leader (bool) –

Return type:

Annotation

create_evaluate_text(i_surf: UserSurface, i_x: float, i_y: float, i_z: float, i_with_leader: bool) → Annotation

Note

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

o Func CreateEvoluateText(UserSurface iSurf,

double iX,

double iY,

double iZ,

boolean iWithLeader) As Annotation

Create a Text.

Parameters:

iSurf

User surface needed to construct the Text.

iX

X coordinate.

iY

Y coordinate.

iZ

Z coordinate.

iWithLeader

Create or not a leader on the annotation. If the leader is

requested: The activated TPSView shall not be parallel to the surface pointed

by the annotation Text. If the activated TPSView is parallel to the surface

pointed: - The leader will be disconnected - The extremity of the leader will

be positioned at the origin of the part - The annotation Text is created but

its status will be KO.

oText

The new created Text.

Parameters:

• i_surf (UserSurface) –

• i_x (float) –

• i_y (float) –

• i_z (float) –

• i_with_leader (bool) –

Return type:

Annotation

create_flag_note(i_surf: UserSurface) → Annotation

Note

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

o Func CreateFlagNote(UserSurface iSurf) As Annotation

Create a FlagNote.

Parameters:

iSurf

User surface needed to construct the Flag Note.

oFlagNote

The new created Flag Note.

Parameters:

i_surf (UserSurface) –

Return type:

Annotation

create_non_semantic_dimension(i_surf: UserSurface, i_dimension_type: cat_variant, i_linear_dim_sub_type: cat_variant) → Annotation

Note

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

o Func CreateNonSemanticDimension(UserSurface iSurf,

CATVariant iDimensionType,

CATVariant iLinearDimSubType) As Annotation

Creates a non semantic Dimension specification.

Parameters:

iSurf

User surface needed to construct the Dimension.

iDimensionType

Type of the Dimension 0 : CATTPSUndefDimension 1 : CATTPSLinearDimension 2 : CATTPSAngularDimension 3 : CATTPSSecondLinearDim 4 : CATTPSChamferDimension 5 : CATTPSOrientedLinearDimension 6 : CATTPSOrientedAngularDimension

iLinearDimSubType

Sub type of LinearDimension type 0 : CATTPSDistanceDimension 1 : CATTPSDiameterDimension 2 : CATTPSRadiusDimension 3 : CATTPSThreadDimension 4 : CATTPSChamfDistDistDimension 5 : CATTPSChamfDistAngDimension

oDimension

The new created Dimension.

Parameters:

• i_surf (UserSurface) –

• i_dimension_type (cat_variant) –

• i_linear_dim_sub_type (cat_variant) –

Return type:

Annotation

create_roughness(i_surf: UserSurface) → Annotation

Note

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

o Func CreateRoughness(UserSurface iSurf) As Annotation

Create a Roughness.

Parameters:

iSurf

User surface needed to construct the Roughness.

oRoughness

The new created Roughness.

Parameters:

i_surf (UserSurface) –

Return type:

Annotation

create_semantic_dimension(i_surf: UserSurface, i_type: cat_variant, i_sub_type: cat_variant) → Annotation

Note

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

o Func CreateSemanticDimension(UserSurface iSurf,

CATVariant iType,

CATVariant iSubType) As Annotation

Creates a semantic Dimension specification.

Parameters:

oDimension

The new created Dimension.

Parameters:

• i_surf (UserSurface) –

• i_type (cat_variant) –

• i_sub_type (cat_variant) –

Return type:

Annotation

create_text(i_surf: UserSurface) → Annotation

Note

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

o Func CreateText(UserSurface iSurf) As Annotation

Create a Text.

Parameters:

iAnnotation

Annotation on which the Text will be .

oText

The new created Text.

Parameters:

i_surf (UserSurface) –

Return type:

Annotation

create_text_noa(i_surf: UserSurface) → Noa

Note

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

o Func CreateTextNOA(UserSurface iSurf) As Noa

Create a “Text” NOA

Parameters:

iSurf

The user surface on which you apply the created NOA.

oNoa

The new created NOA.

Parameters:

i_surf (UserSurface) –

Return type:

Noa

create_text_note_object_attribute(i_surf: UserSurface, i_noa_type: str) → Noa

Note

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

o Func CreateTextNoteObjectAttribute(UserSurface iSurf,

CATBSTR iNOAType) As Noa

Create a “Text” NOA (Note Object Attribute)

Parameters:

iSurf

The user surface on which you apply the created NOA.

iNOAType

Type of the created NOA; this string defines the Type of Noa. This

type can be filtered using the Filter command.

oNoa

The new created NOA.

Parameters:

• i_surf (UserSurface) –

• i_noa_type (str) –

Return type:

Noa

create_text_on_annot(i_text: str, i_annot: Annotation) → Annotation

Note

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

o Func CreateTextOnAnnot(CATBSTR iText,

Annotation iAnnot) As Annotation

Create a Text grouped to an annotation.

Parameters:

iText

Character string that makes up the text.

iAnnot

Annotation reference needed to group the Text.

oText

The new created Text.

Parameters:

• i_text (str) –

• i_annot (Annotation) –

Return type:

Annotation

create_tolerance_with_drf(i_index: cat_variant, i_surf: UserSurface, i_drf: Annotation) → Annotation

Note

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

o Func CreateToleranceWithDRF(CATVariant iIndex,

UserSurface iSurf,

Annotation iDRF) As Annotation

Create a Tolerance With a Reference Frame DRF. iType = 1 : Angularity

Parameters:

• i_index (cat_variant) –

• i_surf (UserSurface) –

• i_drf (Annotation) –

Return type:

Annotation

create_tolerance_without_drf(i_index: cat_variant, i_surf: UserSurface) → Annotation

Note

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

o Func CreateToleranceWithoutDRF(CATVariant iIndex,

UserSurface iSurf) As Annotation

Create a Tolerance Without a Reference Frame (DRF). iType = 1 : Straightness 2 : AxisStraightness 3 : Flatness 4 : Circularity 5 : Cylindricity 6 : ProfileOfALine 7 : ProfileOfASurface 8 : Position

Parameters:

• i_index (cat_variant) –

• i_surf (UserSurface) –

Return type:

Annotation

instantiate_noa(i_noa: Noa, i_surf: UserSurface) → Annotation

Note

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

o Func InstanciateNOA(Noa iNoa,

UserSurface iSurf) As Annotation

Instanciate an NOA from a Reference NOA.

Parameters:

iNOA

Reference NOA.

iSurf

User surface needed to construct the Dimension.

oNOA

The new instanciated NOA.

Parameters:

• i_noa (Noa) –

• i_surf (UserSurface) –

Return type:

Annotation