WeldPmiBuilder Class¶
-
class
NXOpen.Weld.WeldPmiBuilder¶ Bases:
NXOpen.BuilderCreate PMI symbols for multiple structure welds, this builder’s Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject’s output array is stable.
To create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateWeldPmiBuilder()Default values.
Property Value PlaneType ModelView SpaceFactor 1.0 New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| Objects | Returns the objects (either features or curves) that are used to create PMI symbols. |
| PlaneType | Returns or sets the plane type. |
| SpaceFactor | Returns or sets the space factor. |
| Style | Returns the Annotations.StyleBuilder for the annotation. |
| Tag | Returns the Tag for this object. |
| UserCoordinateSystem | Returns or sets the user specified coordinate system. |
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. |
| 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¶
| WeldPmiBuilderOrientationPlaneType Enumeration | This represents the Orientation Plane Type. |
Property Detail¶
Objects¶
-
WeldPmiBuilder.Objects¶ Returns the objects (either features or curves) that are used to create PMI symbols.
-------------------------------------Getter Method
Signature
ObjectsReturns: Selected weld objects list. Return type: NXOpen.SelectNXObjectListNew in version NX9.0.0.
License requirements: None.
PlaneType¶
-
WeldPmiBuilder.PlaneType¶ Returns or sets the plane type.
-------------------------------------Getter Method
Signature
PlaneTypeReturns: Return type: NXOpen.Weld.WeldPmiBuilderOrientationPlaneTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneTypeParameters: planeType ( NXOpen.Weld.WeldPmiBuilderOrientationPlaneType) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
SpaceFactor¶
-
WeldPmiBuilder.SpaceFactor¶ Returns or sets the space factor.
The value is greater than zero.
-------------------------------------Getter Method
Signature
SpaceFactorReturns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpaceFactorParameters: spaceFactor (float) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
Style¶
-
WeldPmiBuilder.Style¶ Returns the
Annotations.StyleBuilderfor the annotation.-------------------------------------Getter Method
Signature
StyleReturns: Return type: NXOpen.Annotations.StyleBuilderNew in version NX9.0.0.
License requirements: None.
UserCoordinateSystem¶
-
WeldPmiBuilder.UserCoordinateSystem¶ Returns or sets the user specified coordinate system.
-------------------------------------Getter Method
Signature
UserCoordinateSystemReturns: Return type: NXOpen.CoordinateSystemNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UserCoordinateSystemParameters: userCsys ( NXOpen.CoordinateSystem) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”) OR structure_weld (“STRUCTURE WELD”)
Method Detail¶
Validate¶
-
WeldPmiBuilder.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.