SurfaceFinishBuilder Class¶
-
class
NXOpen.Annotations.
SurfaceFinishBuilder
¶ Bases:
NXOpen.Annotations.BaseSurfaceFinishBuilder
Represents a
NXOpen.Annotations.SurfaceFinish
builderTo create a new instance of this class, use
NXOpen.Annotations.PmiAttributeCollection.CreateSurfaceFinishBuilder()
New in version NX6.0.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.SurfaceFinishBuilder.B | Returns or sets the b |
BusinessModifier | Returns or sets the business modifier |
NXOpen.Annotations.SurfaceFinishBuilder.C | Returns or sets the c |
NXOpen.Annotations.SurfaceFinishBuilder.D | Returns or sets the d |
NXOpen.Annotations.SurfaceFinishBuilder.E | Returns or sets the e |
F1 | Returns or sets the f1 |
F2 | Returns or sets the f2 |
Finish | Returns or sets the finish |
InvertSymbol | Returns or sets the invert symbol |
InvertText | Returns or sets the invert text flag |
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 |
Standard | Returns or sets the standard |
Style | Returns the NXOpen.Annotations.StyleBuilder for the annotation |
Tag | Returns the Tag for this object. |
Title | Returns or sets the title |
Tolerance | Returns or sets the tolerance in case of bilateral tolerance type otherwise upper tolerance |
ToleranceType | Returns or sets the tolerance type is applicable only where Material Removal is 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 |
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 surface finish is inherited form existing 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¶
SurfaceFinishBuilderFinishType Enumeration | the valid types for pmi finish type |
SurfaceFinishBuilderStandardType Enumeration | the valid types for pmi surface finish standards |
Property Detail¶
A1¶
-
SurfaceFinishBuilder.
A1
¶ Returns or sets the a1
-------------------------------------
Getter Method
Signature
A1
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
A1
Parameters: a1 (str) – New in version NX6.0.0.
License requirements: None.
A2¶
-
SurfaceFinishBuilder.
A2
¶ Returns or sets the a2
-------------------------------------
Getter Method
Signature
A2
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
A2
Parameters: a2 (str) – New in version NX6.0.0.
License requirements: None.
Angle¶
-
SurfaceFinishBuilder.
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
Parameters: angle (float) – New in version NX7.5.0.
License requirements: None.
B¶
-
SurfaceFinishBuilder.
B
¶ Returns or sets the b
-------------------------------------
Getter Method
Signature
B
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
B
Parameters: b (str) – New in version NX6.0.0.
License requirements: None.
C¶
-
SurfaceFinishBuilder.
C
¶ Returns or sets the c
-------------------------------------
Getter Method
Signature
C
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
C
Parameters: c (str) – New in version NX6.0.0.
License requirements: None.
D¶
-
SurfaceFinishBuilder.
D
¶ Returns or sets the d
-------------------------------------
Getter Method
Signature
D
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
D
Parameters: d (str) – New in version NX6.0.0.
License requirements: None.
E¶
-
SurfaceFinishBuilder.
E
¶ Returns or sets the e
-------------------------------------
Getter Method
Signature
E
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
E
Parameters: e (str) – New in version NX6.0.0.
License requirements: None.
F1¶
-
SurfaceFinishBuilder.
F1
¶ Returns or sets the f1
-------------------------------------
Getter Method
Signature
F1
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
F1
Parameters: f1 (str) – New in version NX6.0.0.
License requirements: None.
F2¶
-
SurfaceFinishBuilder.
F2
¶ Returns or sets the f2
-------------------------------------
Getter Method
Signature
F2
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
F2
Parameters: f2 (str) – New in version NX6.0.0.
License requirements: None.
Finish¶
-
SurfaceFinishBuilder.
Finish
¶ Returns or sets the finish
-------------------------------------
Getter Method
Signature
Finish
Returns: Return type: NXOpen.Annotations.SurfaceFinishBuilderFinishType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Finish
Parameters: finish ( NXOpen.Annotations.SurfaceFinishBuilderFinishType
) –New in version NX6.0.0.
License requirements: None.
InvertSymbol¶
-
SurfaceFinishBuilder.
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
Parameters: invertSymbol (bool) – New in version NX7.5.2.
License requirements: None.
InvertText¶
-
SurfaceFinishBuilder.
InvertText
¶ Returns or sets the invert text flag
-------------------------------------
Getter Method
Signature
InvertText
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InvertText
Parameters: invertText (bool) – New in version NX7.5.0.
License requirements: None.
LowerTolerance¶
-
SurfaceFinishBuilder.
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
Parameters: lowerTolerance (float) – New in version NX7.5.0.
License requirements: None.
Parantheses¶
-
SurfaceFinishBuilder.
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.SurfaceFinishBuilder.Parentheses`()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Parantheses
Parameters: paranthesesType ( NXOpen.Annotations.BaseSurfaceFinishBuilderParanthesesType
) –New in version NX7.5.0.
Deprecated since version NX8.0.0: Use
NXOpen.Annotations.SurfaceFinishBuilder.Parentheses`()
instead.License requirements: None.
Parentheses¶
-
SurfaceFinishBuilder.
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
Parameters: parenthesesType ( NXOpen.Annotations.BaseSurfaceFinishBuilderParenthesesType
) –New in version NX8.0.0.
License requirements: None.
SingleRoughnessValue¶
-
SurfaceFinishBuilder.
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
Parameters: singleRoughnessValue (bool) – New in version NX8.0.0.
License requirements: None.
Standard¶
-
SurfaceFinishBuilder.
Standard
¶ Returns or sets the standard
-------------------------------------
Getter Method
Signature
Standard
Returns: Return type: NXOpen.Annotations.SurfaceFinishBuilderStandardType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Standard
Parameters: standard ( NXOpen.Annotations.SurfaceFinishBuilderStandardType
) –New in version NX6.0.0.
License requirements: None.
Title¶
-
SurfaceFinishBuilder.
Title
¶ Returns or sets the title
-------------------------------------
Getter Method
Signature
Title
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Title
Parameters: title (str) – New in version NX6.0.0.
License requirements: None.
Tolerance¶
-
SurfaceFinishBuilder.
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
Parameters: tolerance (float) – New in version NX7.5.0.
License requirements: None.
ToleranceType¶
-
SurfaceFinishBuilder.
ToleranceType
¶ Returns or sets the tolerance type is applicable only where Material Removal is required
-------------------------------------
Getter Method
Signature
ToleranceType
Returns: Return type: NXOpen.Annotations.BaseSurfaceFinishBuilderToleranceOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceType
Parameters: toleranceType ( NXOpen.Annotations.BaseSurfaceFinishBuilderToleranceOption
) –New in version NX7.5.0.
License requirements: None.
Method Detail¶
InheritFrom¶
-
SurfaceFinishBuilder.
InheritFrom
¶ The surface finish is inherited form existing surface finish.
Signature
InheritFrom(inheritTag)
Parameters: inheritTag ( NXOpen.Annotations.SurfaceFinish
) –New in version NX8.5.0.
License requirements: None.
Validate¶
-
SurfaceFinishBuilder.
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.