All Frameworks  Object Hierarchy  This Framework  Indexes

Annotation (Object)

Interface for the Technological Product Specification (TPS) objects.
Leaf entity in the Design Pattern Composite. TPS modeler enables definition of specification related to surfaces.

Property Index

SuperType
Get the Super Type.
TPSStatus
Get the TPS Status.
Type
Get the Type.
Z
method get_Z will never be exposed Set the offset of the annotation

Method Index

AddLeader
Add a leader.
ApplyReferencedGeomColor
Apply a color to referenced geometry.
ApplyReferencedInitColor
Apply the initial color to referenced geometry.
AssociatedRefFrame
Get the annotation on the AssociatedRefFrame interface.
CompositeTolerance
Get the annotation on the CompositeTolerance interface.
ControledRadius
Get the annotation on the ControledRadius interface.
DatumSimple
Get the annotation on the DatumSimple interface.
DatumTarget
Get the annotation on the DatumTarget interface.
DefaultAnnotation
Get the annotation on the DefaultAnnotation interface.
Dimension3D
Get the 3D Dimension on the 3D Dimension interface.
DimensionLimit
Get the annotation on the DimensionLimit interface.
DimensionPattern
Get the annotation on the DimensionPattern interface.
EnvelopCondition
Get the annotation on the EnvelopCondition interface.
FlagNote
Get the annotation on the FlagNote interface.
FreeState
Get the annotation on the FreeState interface.
GetSurfacesCount
Count the geometry on which the Annotation is applied to.
GetSurfaces
Get the geometry on which the Annotation is applied to.
HasAControledRadius
To know if the Annotation has a Controled Radius.
HasAFreeState
To know if the Annotation has a Free State.
HasAMaterialCondition
To know if the Annotation has a Material Condition.
HasAParticularTolElem
To know if the Annotation has a Particuler Element.
HasATolerancePerUnitBasisRestrictiveValue
To know if the Annotation has a Tolerance Per Unit Basis Restricted Value.
HasAnEnvelopCondition
To know if the Annotation has an Envelop Condition.
HasDimensionLimit
To know if the Annotation has a Dimension Limit.
IsACompositeTolerance
To know if the Annotation is a composite Tolerance.
IsADefaultAnnotation
To know if the Annotation is a Default Annotation.
IsADimensionPattern
To know if the Annotation is a Dimension Pattern.
IsAProjectedToleranceZone
To know if the Annotation is a Projected Zone.
IsAShiftedProfileTolerance
To know if the Annotation is a Shifted Profile Tolerance.
IsATangentPlane
To know if the Annotation is a Tangent Plane.
IsAToleranceUnitBasisValue
To know if the Annotation is a Tolerance Unit Basis Value.
IsAToleranceZone
Is the a Tolerance Zone.
IsAnAssociatedRefFrame
To know if the Annotation is an Associated Reference Frame.
MaterialCondition
Get the annotation on the MaterialCondition interface.
ModifyVisu
To refresh the 3D visualization.
Noa
Get the annotation on the Noa interface.
ParticularTolElem
Get the annotation on the ParticularTolElem interface.
ProjectedToleranceZone
Get the annotation on the ProjectedToleranceZone interface.
ReferenceFrame
Get the annotation on the ReferenceFrame interface.
Roughness
Get the annotation on the Roughness interface.
SetXY
method GetXY will never be exposed Set TPS coordinates in the view
ShiftedProfileTolerance
Get the annotation on the ShiftedProfileTolerance interface.
TangentPlane
Get the annotation on the TangentPlane interface.
Text
Get the annotation on the Text interface.
TolerancePerUnitBasisRestrictiveValue
Get the annotation on the TolerancePerUnitBasisRestrictiveValue interface.
ToleranceUnitBasisValue
Get the annotation on the ToleranceUnitBasisValue interface.
ToleranceZone
Get the annotation on the ToleranceZone interface.
TransfertToView
Move the annotation in another view.

Properties


o Property SuperType() As (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"
o Property TPSStatus() As (Read Only)
Get the TPS Status.
Parameters:
oStatus
The Status.
o Property Type() As (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"
o Property Z( iZ) (Write Only)
method get_Z will never be exposed Set the offset of the annotation
Parameters:
iZ
The offset.

Methods


o Sub AddLeader()
Add a leader.
o Sub ApplyReferencedGeomColor( iReleatedR,
iReleatedG,
iReleatedB)
Apply a color to referenced geometry.
o Sub ApplyReferencedInitColor()
Apply the initial color to referenced geometry.
o Func AssociatedRefFrame() As
Get the annotation on the AssociatedRefFrame interface.
o Func CompositeTolerance() As
Get the annotation on the CompositeTolerance interface.
o Func ControledRadius() As
Get the annotation on the ControledRadius interface.
o Func DatumSimple() As
Get the annotation on the DatumSimple interface.
o Func DatumTarget() As
Get the annotation on the DatumTarget interface.
o Func DefaultAnnotation() As
Get the annotation on the DefaultAnnotation interface.
o Func Dimension3D() As
Get the 3D Dimension on the 3D Dimension interface.
Parameters:
oDim
The 3D Dimension.
o Func DimensionLimit() As
Get the annotation on the DimensionLimit interface.
o Func DimensionPattern() As
Get the annotation on the DimensionPattern interface.
o Func EnvelopCondition() As
Get the annotation on the EnvelopCondition interface.
o Func FlagNote() As
Get the annotation on the FlagNote interface.
Parameters:
oFlagNote
The annotation Flag Note.
o Func FreeState() As
Get the annotation on the FreeState interface.
o Func GetSurfacesCount() As
Count the geometry on which the Annotation is applied to.
o Sub GetSurfaces( oSafeArray)
Get the geometry on which the Annotation is applied to.
o Func HasAControledRadius() As
To know if the Annotation has a Controled Radius.
o Func HasAFreeState() As
To know if the Annotation has a Free State.
o Func HasAMaterialCondition() As
To know if the Annotation has a Material Condition.
o Func HasAParticularTolElem() As
To know if the Annotation has a Particuler Element.
o Func HasATolerancePerUnitBasisRestrictiveValue() As
To know if the Annotation has a Tolerance Per Unit Basis Restricted Value.
o Func HasAnEnvelopCondition() As
To know if the Annotation has an Envelop Condition.
o Func HasDimensionLimit() As
To know if the Annotation has a Dimension Limit.
o Func IsACompositeTolerance() As
To know if the Annotation is a composite Tolerance.
o Func IsADefaultAnnotation() As
To know if the Annotation is a Default Annotation.
o Func IsADimensionPattern() As
To know if the Annotation is a Dimension Pattern.
o Func IsAProjectedToleranceZone() As
To know if the Annotation is a Projected Zone.
o Func IsAShiftedProfileTolerance() As
To know if the Annotation is a Shifted Profile Tolerance.
o Func IsATangentPlane() As
To know if the Annotation is a Tangent Plane.
o Func IsAToleranceUnitBasisValue() As
To know if the Annotation is a Tolerance Unit Basis Value.
o Func IsAToleranceZone() As
Is the a Tolerance Zone.
o Func IsAnAssociatedRefFrame() As
To know if the Annotation is an Associated Reference Frame.
o Func MaterialCondition() As
Get the annotation on the MaterialCondition interface.
o Sub ModifyVisu()
To refresh the 3D visualization.
o Func Noa() As
Get the annotation on the Noa interface.
o Func ParticularTolElem() As
Get the annotation on the ParticularTolElem interface.
o Func ProjectedToleranceZone() As
Get the annotation on the ProjectedToleranceZone interface.
o Func ReferenceFrame() As
Get the annotation on the ReferenceFrame interface.
o Func Roughness() As
Get the annotation on the Roughness interface.
o Sub SetXY( iX,
iY)
method GetXY will never be exposed Set TPS coordinates in the view
Parameters:
oX
The X coordinate.
oY
The Y coordinate.
o Func ShiftedProfileTolerance() As
Get the annotation on the ShiftedProfileTolerance interface.
o Func TangentPlane() As
Get the annotation on the TangentPlane interface.
o Func Text() As
Get the annotation on the Text interface.
Parameters:
oText
The annotation Text.
o Func TolerancePerUnitBasisRestrictiveValue() As
Get the annotation on the TolerancePerUnitBasisRestrictiveValue interface.
o Func ToleranceUnitBasisValue() As
Get the annotation on the ToleranceUnitBasisValue interface.
o Func ToleranceZone() As
Get the annotation on the ToleranceZone interface.
o Sub TransfertToView( iView)
Move the annotation in another view.
Parameters:
iView
The destination view.

Copyright © 2003, Dassault Systèmes. All rights reserved.