PipingComponentFileBuilder Class¶
-
class
NXOpen.MechanicalRouting.PipingComponentFileBuilder¶ Bases:
NXOpen.Builderthe Builder for PipingComponentFile data
To create a new instance of this class, use
NXOpen.MechanicalRouting.BuilderFactory.CreatePipingComponentFileBuilder()New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| ComponentsCollector | Returns the selected components |
| PcfFileName | Returns or sets the pcf file name. |
| Tag | Returns the Tag for this object. |
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. |
Property Detail¶
ComponentsCollector¶
-
PipingComponentFileBuilder.ComponentsCollector¶ Returns the selected components
-------------------------------------Getter Method
Signature
ComponentsCollectorReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX12.0.0.
License requirements: routing_pipetube (“Routing Piping and Tubing”)
PcfFileName¶
-
PipingComponentFileBuilder.PcfFileName¶ Returns or sets the pcf file name.
-------------------------------------Getter Method
Signature
PcfFileNameReturns: Return type: str New in version NX12.0.0.
License requirements: routing_pipetube (“Routing Piping and Tubing”)
-------------------------------------Setter Method
Signature
PcfFileNameParameters: fileName (str) – New in version NX12.0.0.
License requirements: routing_pipetube (“Routing Piping and Tubing”)
Method Detail¶
Validate¶
-
PipingComponentFileBuilder.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.