PipeStockBuilder Class¶
-
class
NXOpen.DiagrammingLibraryAuthor.
PipeStockBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a PipeStockBuilder.
New in version NX11.0.1.
Methods¶
Method | Description |
---|---|
CreatePipeStock | Creates a new pipe stock |
DeletePipeStock | Deletes the pipe stock which is new created |
GetPipeStockObjects | Gets the pipe stock objects which have user attributes of the pipe stock. |
SelectFolder | Selects the pipe stock folder by the class ID |
SelectPipeStock | Selects one pipe stock by the symbol ID |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Method Detail¶
CreatePipeStock¶
-
PipeStockBuilder.
CreatePipeStock
¶ Creates a new pipe stock
Signature
CreatePipeStock(instanceId, partId, partName, numberName)
Parameters: - instanceId (str) –
- partId (str) –
- partName (str) –
- numberName (str) –
Returns: the pipe stock object
Return type: New in version NX11.0.1.
License requirements: None.
DeletePipeStock¶
-
PipeStockBuilder.
DeletePipeStock
¶ Deletes the pipe stock which is new created
Signature
DeletePipeStock(pipeStockObject)
Parameters: pipeStockObject ( NXOpen.DiagrammingLibraryAuthor.AttributeHolder
) – the pipe stock object, only accept the object which is got byNXOpen.DiagrammingLibraryAuthor.PipeStockBuilder.CreatePipeStock()
New in version NX11.0.1.
License requirements: None.
GetPipeStockObjects¶
-
PipeStockBuilder.
GetPipeStockObjects
¶ Gets the pipe stock objects which have user attributes of the pipe stock.
Signature
GetPipeStockObjects()
Returns: the pipe stock objects Return type: list of NXOpen.DiagrammingLibraryAuthor.AttributeHolder
New in version NX11.0.1.
License requirements: None.
SelectFolder¶
-
PipeStockBuilder.
SelectFolder
¶ Selects the pipe stock folder by the class ID
Signature
SelectFolder(classId)
Parameters: classId (str) – New in version NX11.0.1.
License requirements: None.
SelectPipeStock¶
-
PipeStockBuilder.
SelectPipeStock
¶ Selects one pipe stock by the symbol ID
Signature
SelectPipeStock(symbolId)
Parameters: symbolId (str) – New in version NX11.0.1.
License requirements: None.
Validate¶
-
PipeStockBuilder.
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.