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)¶
Note
CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectAnnotation2Interface for the Technological Product Specification (TPS)objects.Leaf entity in the Design Pattern Composite. TPS modeler enables definition ofspecification 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
- datum_simple() DatumSimple ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func DatumSimple() As DatumSimpleGets the annotation on the DatumSimple interface.
- Return type:
- datum_target() DatumTarget ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func DatumTarget() As DatumTargetGets the annotation on the DatumTarget interface.
- Return type:
- default_annotation() DefaultAnnotation ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func DefaultAnnotation() As DefaultAnnotationGets the annotation on the DefaultAnnotation interface.
- Return type:
- dimension_3d() Dimension3D ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func Dimension3D() As Dimension3DGets the 3D Dimension on the 3D Dimension interface.Parameters:oDimThe 3D Dimension.
- Return type:
- flag_note() FlagNote ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func FlagNote() As FlagNoteGets the annotation on the FlagNote interface.Parameters:oFlagNoteThe annotation Flag Note.
- Return type:
- 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 longCounts 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 booleanChecks if the Annotation uses a visualization dimension for its attachmentto the geometry.
- 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 booleanTo 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 NoaGets the annotation on the Noa interface.
- Return type:
- non_semantic_datum() NonSemanticDatum ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func NonSemanticDatum() As NonSemanticDatumGets the annotation on the DatumSimple interface.
- Return type:
- non_semantic_datum_target() NonSemanticDatumTarget ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func NonSemanticDatumTarget() As NonSemanticDatumTargetGets the annotation on the DatumSimple interface.
- Return type:
- non_semantic_dimension() NonSemanticDimension ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func NonSemanticDimension() As NonSemanticDimensionGets the annotation on the DatumSimple interface.
- Return type:
- non_semantic_gdt() NonSemanticGDT ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func NonSemanticGDT() As NonSemanticGDTGets the annotation on the DatumSimple interface.
- Return type:
- reference_frame() ReferenceFrame ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ReferenceFrame() As ReferenceFrameGets the annotation on the ReferenceFrame interface.
- Return type:
- roughness() Roughness ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func Roughness() As RoughnessGets the annotation on the Roughness interface.
- Return type:
- semantic_gdt() SemanticGDT ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func SemanticGDT() As SemanticGDTGets the annotation on the DatumSimple interface.
- Return type:
- 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 theviewParameters:oXThe X coordinate.oYThe 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:oSuperTypeThe 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 TextGets the annotation on the Text interface.Parameters:oTextThe annotation Text.
- Return type:
- 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:oStatusThe 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:iViewThe 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:oTypeThe 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 Dimension3DGets the dimension visualization associated with theannotation.Parameters:oDimThe visualization Dimension oDim employed by the annotation todisplay its link to the geometry.
- Return type:
- weld() Weld ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func Weld() As WeldGets the annotation on the Weld interface.
- Return type:
- 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 theannotationParameters:iZThe offset.
- Return type:
float