pycatia.cat_tps_interfaces.annotation_factory_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_factory_2.AnnotationFactory2(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
AnnotationFactory2

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) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateDatum(UserSurface iSurf) As Annotation2

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:

Annotation2

create_datum_reference_frame() → Annotation2

Note

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

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

Annotation2

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateDatumTarget(UserSurface iSurf,
Annotation2 iDatum) As Annotation2

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:
Return type:

Annotation2

create_ditto_noa(i_surf: UserSurface, i_noa_type: str, i_ditto: DrawingComponent, i_stick_to_geometry_option: bool) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateDittoNOA(UserSurface iSurf,
CATBSTR iNOAType,
DrawingComponent iDitto,
boolean iStickToGeometryOption) As Annotation2

Create a “Ditto” NOA

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.
iDitto
The drawing component selected to provide NOA display.

iStickToGeometryOption
This flag is TRUE to tell the factory that Stick Ditto
perpendicularly to geometry option is selected. In this case, the ditto is
instantiated without frame or leader and its origin point is stuck and set on
the selected geometry. In addition, the default anchor point position is the
middle center. This argument is to be set to FALSE if leader attachment to
point out geometry is expected.
oNoa
The new created NOA.
Parameters:
Return type:

Annotation2

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

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 Annotation2

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:

Annotation2

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

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 Annotation2

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:

Annotation2

create_flag_note(i_surf: UserSurface) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateFlagNote(UserSurface iSurf) As Annotation2

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:

Annotation2

create_non_semantic_dimension(i_surf: UserSurface, i_type: cat_variant, i_sub_type: cat_variant) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateNonSemanticDimension(UserSurface iSurf,
CATVariant iType,
CATVariant iSubType) As Annotation2

Creates a non semantic Dimension specification.

Parameters:

iSurf
User surface needed to construct the Dimension.
iSubType
: 1 CATTPSDiameterDimension 2 CATTPSRadiusDimension
iType
: 1 Linear Dimension 2 Angular Dimension 3 Second Linear Dim (Small diameter/radius for torus)
oDimension
The new created Dimension.
Parameters:

  • i_surf (UserSurface) –

  • i_type (cat_variant) –

  • i_sub_type (cat_variant) –

Return type:

Annotation2

create_roughness(i_surf: UserSurface) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateRoughness(UserSurface iSurf) As Annotation2

Create a Roughness.

Parameters:

iSurf
User surface needed to construct the Roughness.
oRoughness
The new created Roughness.
Parameters:

i_surf (UserSurface) –

Return type:

Annotation2

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateSemanticDimension(UserSurface iSurf,
CATVariant iType,
CATVariant iSubType) As Annotation2

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:

Annotation2

create_text(i_surf: UserSurface) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateText(UserSurface iSurf) As Annotation2

Create a Text.

Parameters:

iSurf
User surface needed to construct the Text.
oText
The new created Text.
Parameters:

i_surf (UserSurface) –

Return type:

Annotation2

create_text_noa(i_surf: UserSurface) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateTextNOA(UserSurface iSurf) As Annotation2

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:

Annotation2

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateTextNoteObjectAttribute(UserSurface iSurf,
CATBSTR iNOAType) As Annotation2

Create a “Text” NOA

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:
Return type:

Annotation2

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateTextOnAnnot(CATBSTR iText,
Annotation2 iAnnot) As Annotation2

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:
Return type:

Annotation2

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateToleranceWithDRF(CATVariant iIndex,
UserSurface iSurf,
Annotation2 iDRF) As Annotation2

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

Annotation2

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

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateToleranceWithoutDRF(CATVariant iIndex,
UserSurface iSurf) As Annotation2

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:
Return type:

Annotation2

create_weld(i_surf: UserSurface) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateWeld(UserSurface iSurf) As Annotation2

Create a Weld

Parameters:

iSurf
The user surface on which you apply the new Weld.
oWeld
The new created Weld Feature.
Parameters:

i_surf (UserSurface) –

Return type:

Annotation2

instantiate_noa(i_noa: Annotation2, i_surf: UserSurface) → Annotation2

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func InstanciateNOA(Annotation2 iNoa,
UserSurface iSurf) As Annotation2

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:
Return type:

Annotation2