DatumTargetBuilder Class¶
-
class
NXOpen.Annotations.
DatumTargetBuilder
¶ Bases:
NXOpen.Builder
Represents a Datum target Builder
This is an abstract class, and cannot be instantiated.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AreaSize | Returns or sets the area size |
DatumTargetStandard | Returns or sets the datum target standard. |
DrawX | Returns or sets the draw x |
Height | Returns the height |
Index | Returns or sets the index |
InnerDiameter | Returns the inner diameter |
Label | Returns or sets the label |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
Movable | Returns or sets the flag that indicates movable . |
MovableModifierAngle | Returns the movable modifier angle |
Origin | Returns the origin |
OuterDiameter | Returns the outer diameter |
Style | Returns the style |
Tag | Returns the Tag for this object. |
TerminatorType | Returns or sets the terminator type |
Type | Returns or sets the type |
Width | Returns the width |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
InheritFrom | The datum target is inherited form existing datum target. |
ReverseMovableModifier | Reverses the Movable datum target direction by 180 degree |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
DatumTargetBuilderStandardTypes Enumeration | represents the datum target standards |
DatumTargetBuilderTerminatorTypes Enumeration | represents the datum target terminator type |
DatumTargetBuilderTypes Enumeration | datum symbol type |
Property Detail¶
AreaSize¶
-
DatumTargetBuilder.
AreaSize
¶ Returns or sets the area size
-------------------------------------
Getter Method
Signature
AreaSize()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AreaSize(areaSize)
Parameters: areaSize (str) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DatumTargetStandard¶
-
DatumTargetBuilder.
DatumTargetStandard
¶ Returns or sets the datum target standard.
-------------------------------------
Getter Method
Signature
DatumTargetStandard()
Returns: Return type: NXOpen.Annotations.DatumTargetBuilderStandardTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DatumTargetStandard(standard)
Parameters: standard ( NXOpen.Annotations.DatumTargetBuilderStandardTypes
) –New in version NX10.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DrawX¶
-
DatumTargetBuilder.
DrawX
¶ Returns or sets the draw x
-------------------------------------
Getter Method
Signature
DrawX()
Returns: Return type: bool New in version NX6.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.DatumTargetBuilder.TerminatorTypes`()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
DrawX(flag)
Parameters: flag (bool) – New in version NX6.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.DatumTargetBuilder.TerminatorTypes`()
instead.License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Height¶
-
DatumTargetBuilder.
Height
¶ Returns the height
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Index¶
-
DatumTargetBuilder.
Index
¶ Returns or sets the index
-------------------------------------
Getter Method
Signature
Index()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Index(index)
Parameters: index (int) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
InnerDiameter¶
-
DatumTargetBuilder.
InnerDiameter
¶ Returns the inner diameter
-------------------------------------
Getter Method
Signature
InnerDiameter()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Label¶
-
DatumTargetBuilder.
Label
¶ Returns or sets the label
-------------------------------------
Getter Method
Signature
Label()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Label(label)
Parameters: label (str) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Leader¶
-
DatumTargetBuilder.
Leader
¶ Returns the
NXOpen.Annotations.LeaderBuilder
for the annotation-------------------------------------
Getter Method
Signature
Leader()
Returns: Return type: NXOpen.Annotations.LeaderBuilder
New in version NX6.0.0.
License requirements: None.
Movable¶
-
DatumTargetBuilder.
Movable
¶ Returns or sets the flag that indicates movable .
If true then movable.
-------------------------------------
Getter Method
Signature
Movable()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Movable(flag)
Parameters: flag (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
MovableModifierAngle¶
-
DatumTargetBuilder.
MovableModifierAngle
¶ Returns the movable modifier angle
-------------------------------------
Getter Method
Signature
MovableModifierAngle()
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
Origin¶
-
DatumTargetBuilder.
Origin
¶ Returns the origin
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Annotations.OriginBuilder
New in version NX6.0.0.
License requirements: None.
OuterDiameter¶
-
DatumTargetBuilder.
OuterDiameter
¶ Returns the outer diameter
-------------------------------------
Getter Method
Signature
OuterDiameter()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Style¶
-
DatumTargetBuilder.
Style
¶ Returns the style
-------------------------------------
Getter Method
Signature
Style()
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX6.0.0.
License requirements: None.
TerminatorType¶
-
DatumTargetBuilder.
TerminatorType
¶ Returns or sets the terminator type
-------------------------------------
Getter Method
Signature
TerminatorType()
Returns: Return type: NXOpen.Annotations.DatumTargetBuilderTerminatorTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TerminatorType(type)
Parameters: type ( NXOpen.Annotations.DatumTargetBuilderTerminatorTypes
) –New in version NX10.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Type¶
-
DatumTargetBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Annotations.DatumTargetBuilderTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Annotations.DatumTargetBuilderTypes
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Width¶
-
DatumTargetBuilder.
Width
¶ Returns the width
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Method Detail¶
InheritFrom¶
-
DatumTargetBuilder.
InheritFrom
¶ The datum target is inherited form existing datum target.
Signature
InheritFrom(inheritTag)
Parameters: inheritTag ( NXOpen.Annotations.BaseDatumTarget
) –New in version NX8.5.0.
License requirements: None.
ReverseMovableModifier¶
-
DatumTargetBuilder.
ReverseMovableModifier
¶ Reverses the Movable datum target direction by 180 degree
Signature
ReverseMovableModifier()
New in version NX10.0.0.
License requirements: None.
Validate¶
-
DatumTargetBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.