DraftingSurfaceFinishBuilder Class¶
-
class
NXOpen.Annotations.
DraftingSurfaceFinishBuilder
¶ Bases:
NXOpen.Annotations.BaseSurfaceFinishBuilder
Represents a
NXOpen.Annotations.DraftingSurfaceFinish
builderTo create a new instance of this class, use
NXOpen.Annotations.DraftingSurfaceFinishCollection.CreateDraftingSurfaceFinishBuilder
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
A1 | Returns or sets the a1 |
A2 | Returns or sets the a2 |
Angle | Returns or sets the angle |
AssociatedObjects | Returns the NXOpen.Annotations.AssociatedObjectsBuilder for the annotation |
Attribute | Returns or sets the NXOpen.Annotations.Pmi for this annotation |
NXOpen.Annotations.DraftingSurfaceFinishBuilder.B | Returns or sets the b |
BusinessModifier | Returns or sets the business modifier |
NXOpen.Annotations.DraftingSurfaceFinishBuilder.C | Returns or sets the c |
NXOpen.Annotations.DraftingSurfaceFinishBuilder.D | Returns or sets the d |
NXOpen.Annotations.DraftingSurfaceFinishBuilder.E | Returns or sets the e |
F1 | Returns or sets the f1 |
F2 | Returns or sets the f2 |
Finish | Returns or sets the finish |
ForeshorteningSymbol | Returns the foreshortening symbol builder |
InvertSymbol | Returns or sets the invert symbol |
InvertText | Returns or sets the invert Text |
KnowledgeFusionClassName | Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
LowerTolerance | Returns or sets the lower tolerance applicable for all the tolerance types other than Bilateral |
Origin | Returns the NXOpen.Annotations.OriginBuilder for the annotation |
Parantheses | Returns or sets the parantheses. |
Parentheses | Returns or sets the parentheses |
SingleRoughnessValue | Returns or sets the single roughness value |
Style | Returns the NXOpen.Annotations.StyleBuilder for the annotation |
Tag | Returns the Tag for this object. |
Tolerance | Returns or sets the tolerance in case of bilateral tolerance type otherwise upper tolerance |
ToleranceType | Returns or sets the tolerance type applicable only for all the 3 cases of finish type where Material Removal Required |
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. |
GetAttributeValues | Returns the attribute values @return |
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 drafting surface finish is inherited form existing drafting surface finish. |
SetAttributeValues | Sets the attribute values |
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¶
DraftingSurfaceFinishBuilderFinishType Enumeration | the valid types of finish type |
Property Detail¶
A1¶
-
DraftingSurfaceFinishBuilder.
A1
¶ Returns or sets the a1
-------------------------------------
Getter Method
Signature
A1()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
A1(a1)
Parameters: a1 (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
A2¶
-
DraftingSurfaceFinishBuilder.
A2
¶ Returns or sets the a2
-------------------------------------
Getter Method
Signature
A2()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
A2(a2)
Parameters: a2 (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Angle¶
-
DraftingSurfaceFinishBuilder.
Angle
¶ Returns or sets the angle
-------------------------------------
Getter Method
Signature
Angle()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Angle(angle)
Parameters: angle (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
B¶
-
DraftingSurfaceFinishBuilder.
B
¶ Returns or sets the b
-------------------------------------
Getter Method
Signature
B()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
B(b)
Parameters: b (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
C¶
-
DraftingSurfaceFinishBuilder.
C
¶ Returns or sets the c
-------------------------------------
Getter Method
Signature
C()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
C(c)
Parameters: c (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
D¶
-
DraftingSurfaceFinishBuilder.
D
¶ Returns or sets the d
-------------------------------------
Getter Method
Signature
D()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
D(d)
Parameters: d (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
E¶
-
DraftingSurfaceFinishBuilder.
E
¶ Returns or sets the e
-------------------------------------
Getter Method
Signature
E()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
E(e)
Parameters: e (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
F1¶
-
DraftingSurfaceFinishBuilder.
F1
¶ Returns or sets the f1
-------------------------------------
Getter Method
Signature
F1()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
F1(f1)
Parameters: f1 (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
F2¶
-
DraftingSurfaceFinishBuilder.
F2
¶ Returns or sets the f2
-------------------------------------
Getter Method
Signature
F2()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
F2(f2)
Parameters: f2 (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Finish¶
-
DraftingSurfaceFinishBuilder.
Finish
¶ Returns or sets the finish
-------------------------------------
Getter Method
Signature
Finish()
Returns: Return type: NXOpen.Annotations.DraftingSurfaceFinishBuilderFinishType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Finish(finish)
Parameters: finish ( NXOpen.Annotations.DraftingSurfaceFinishBuilderFinishType
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
ForeshorteningSymbol¶
-
DraftingSurfaceFinishBuilder.
ForeshorteningSymbol
¶ Returns the foreshortening symbol builder
-------------------------------------
Getter Method
Signature
ForeshorteningSymbol()
Returns: Return type: NXOpen.Annotations.ForeshorteningSymbolBuilder
New in version NX10.0.0.
License requirements: None.
InvertSymbol¶
-
DraftingSurfaceFinishBuilder.
InvertSymbol
¶ Returns or sets the invert symbol
-------------------------------------
Getter Method
Signature
InvertSymbol()
Returns: Return type: bool New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
InvertSymbol(invertSymbol)
Parameters: invertSymbol (bool) – New in version NX7.5.2.
License requirements: drafting (“DRAFTING”)
InvertText¶
-
DraftingSurfaceFinishBuilder.
InvertText
¶ Returns or sets the invert Text
-------------------------------------
Getter Method
Signature
InvertText()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InvertText(invertText)
Parameters: invertText (bool) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
LowerTolerance¶
-
DraftingSurfaceFinishBuilder.
LowerTolerance
¶ Returns or sets the lower tolerance applicable for all the tolerance types other than Bilateral
-------------------------------------
Getter Method
Signature
LowerTolerance()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LowerTolerance(lowerTolerance)
Parameters: lowerTolerance (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Parantheses¶
-
DraftingSurfaceFinishBuilder.
Parantheses
¶ Returns or sets the parantheses.
This method is deprecated.
-------------------------------------
Getter Method
Signature
Parantheses()
Returns: Return type: NXOpen.Annotations.BaseSurfaceFinishBuilderParanthesesType
New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
NXOpen.Annotations.DraftingSurfaceFinishBuilder.Parentheses`
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Parantheses(paranthesesType)
Parameters: paranthesesType ( NXOpen.Annotations.BaseSurfaceFinishBuilderParanthesesType
) –New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
NXOpen.Annotations.DraftingSurfaceFinishBuilder.Parentheses`
instead.License requirements: drafting (“DRAFTING”)
Parentheses¶
-
DraftingSurfaceFinishBuilder.
Parentheses
¶ Returns or sets the parentheses
-------------------------------------
Getter Method
Signature
Parentheses()
Returns: Return type: NXOpen.Annotations.BaseSurfaceFinishBuilderParenthesesType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Parentheses(parenthesesType)
Parameters: parenthesesType ( NXOpen.Annotations.BaseSurfaceFinishBuilderParenthesesType
) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
SingleRoughnessValue¶
-
DraftingSurfaceFinishBuilder.
SingleRoughnessValue
¶ Returns or sets the single roughness value
-------------------------------------
Getter Method
Signature
SingleRoughnessValue()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SingleRoughnessValue(singleRoughnessValue)
Parameters: singleRoughnessValue (bool) – New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
Tolerance¶
-
DraftingSurfaceFinishBuilder.
Tolerance
¶ Returns or sets the tolerance in case of bilateral tolerance type otherwise upper tolerance
-------------------------------------
Getter Method
Signature
Tolerance()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Tolerance(tolerance)
Parameters: tolerance (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
ToleranceType¶
-
DraftingSurfaceFinishBuilder.
ToleranceType
¶ Returns or sets the tolerance type applicable only for all the 3 cases of finish type where Material Removal Required
-------------------------------------
Getter Method
Signature
ToleranceType()
Returns: Return type: NXOpen.Annotations.BaseSurfaceFinishBuilderToleranceOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceType(toleranceType)
Parameters: toleranceType ( NXOpen.Annotations.BaseSurfaceFinishBuilderToleranceOption
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
InheritFrom¶
-
DraftingSurfaceFinishBuilder.
InheritFrom
¶ The drafting surface finish is inherited form existing drafting surface finish.
Signature
InheritFrom(inheritTag)
Parameters: inheritTag ( NXOpen.Annotations.BaseSurfaceFinish
) –New in version NX8.5.0.
License requirements: None.
Validate¶
-
DraftingSurfaceFinishBuilder.
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.