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.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectAnnotationInterface 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
- 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 AssociatedRefFrameGet the annotation on the AssociatedRefFrame interface.
- Return type:
- composite_tolerance() CompositeTolerance ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func CompositeTolerance() As CompositeToleranceGet the annotation on the CompositeTolerance interface.
- Return type:
- controlled_radius() ControlledRadius ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ControledRadius() As ControledRadiusGet 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 DatumSimpleGet 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 DatumTargetGet 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 DefaultAnnotationGet 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 Dimension3DGet the 3D Dimension on the 3D Dimension interface.Parameters:oDimThe 3D Dimension.
- Return type:
- dimension_limit() DimensionLimit ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func DimensionLimit() As DimensionLimitGet the annotation on the DimensionLimit interface.
- Return type:
- dimension_pattern() DimensionPattern ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func DimensionPattern() As DimensionPatternGet the annotation on the DimensionPattern interface.
- Return type:
- envelop_condition() EnvelopeCondition ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func EnvelopCondition() As EnvelopConditionGet 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 FlagNoteGet the annotation on the FlagNote interface.Parameters:oFlagNoteThe annotation Flag Note.
- Return type:
- free_state() FreeState ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func FreeState() As FreeStateGet the annotation on the FreeState interface.
- Return type:
- 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 doubleCount 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 booleanTo 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 booleanTo 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 booleanTo know if the Annotation has a Material Condition.
- 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanTo 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 booleanIs 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 booleanTo 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 MaterialConditionGet the annotation on the MaterialCondition interface.
- Return type:
- 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 NoaGet the annotation on the Noa interface.
- Return type:
- particular_tol_elem() ParticularTolElem ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ParticularTolElem() As ParticularTolElemGet the annotation on the ParticularTolElem interface.
- Return type:
- projected_tolerance_zone() ProjectedToleranceZone ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ProjectedToleranceZone() As ProjectedToleranceZoneGet the annotation on the ProjectedToleranceZone interface.
- Return type:
- reference_frame() ReferenceFrame ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ReferenceFrame() As ReferenceFrameGet 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 RoughnessGet the annotation on the Roughness 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
- shifted_profile_tolerance() ShiftedProfileTolerance ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ShiftedProfileTolerance() As ShiftedProfileToleranceGet the annotation on the ShiftedProfileTolerance interface.
- Return type:
- 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: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
- tangent_plane() TangentPlane ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func TangentPlane() As TangentPlaneGet the annotation on the TangentPlane interface.
- Return type:
- text() Text ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func Text() As TextGet the annotation on the Text interface.Parameters:oTextThe annotation Text.
- Return type:
- tolerance_per_unit_basis_restrictive_value() TolerancePerUnitBasisRestrictiveValue ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func TolerancePerUnitBasisRestrictiveValue() AsTolerancePerUnitBasisRestrictiveValueGet the annotation on the TolerancePerUnitBasisRestrictiveValue interface.
- Return type:
- tolerance_unit_basis_value() ToleranceUnitBasisValue ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ToleranceUnitBasisValue() As ToleranceUnitBasisValueGet the annotation on the ToleranceUnitBasisValue interface.
- Return type:
- tolerance_zone() ToleranceZone ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func ToleranceZone() As ToleranceZoneGet the annotation on the ToleranceZone interface.
- 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)Get 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)Get 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
- 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