RunBuilder Class¶
-
class
NXOpen.PLAS.
RunBuilder
¶ Bases:
NXOpen.Builder
,NXOpen.IAttributeSourceObjectBuilder
Represents a RunBuilder.
To create a new instance of this class, use
NXOpen.PLAS.PlasManager.CreateRunBuilder()
New in version NX11.0.1.
Properties¶
Property | Description |
---|---|
IsUnassigned | Returns or sets whether the run is unassigned |
LineTypePathId | Returns or sets the line type path ID of the run. |
ObjectApplication | Returns or sets the application name of the run. |
PipeSpecPathId | Returns or sets the pipe specification object of this run. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AutoAssignAttributes | Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign. |
AutoAssignAttributesWithNamingPattern | Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign. |
Commit | Commits any edits that have been applied to the builder. |
CreateAttributeTitleToNamingPatternMap | Creates a map object of attribute titles to their corresponding naming pattern |
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. |
GetLogicalObject | Gets the known logical object. |
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¶
IsUnassigned¶
-
RunBuilder.
IsUnassigned
¶ Returns or sets whether the run is unassigned
-------------------------------------
Getter Method
Signature
IsUnassigned
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsUnassigned
Parameters: isUnassigned (bool) – New in version NX12.0.0.
License requirements: None.
LineTypePathId¶
-
RunBuilder.
LineTypePathId
¶ Returns or sets the line type path ID of the run.
-------------------------------------
Getter Method
Signature
LineTypePathId
Returns: Return type: str New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
LineTypePathId
Parameters: lineTypePathId (str) – New in version NX11.0.1.
License requirements: None.
ObjectApplication¶
-
RunBuilder.
ObjectApplication
¶ Returns or sets the application name of the run.
-------------------------------------
Getter Method
Signature
ObjectApplication
Returns: Return type: str New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ObjectApplication
Parameters: objectApplication (str) – New in version NX11.0.1.
License requirements: None.
PipeSpecPathId¶
-
RunBuilder.
PipeSpecPathId
¶ Returns or sets the pipe specification object of this run.
-------------------------------------
Getter Method
Signature
PipeSpecPathId
Returns: Return type: str New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
PipeSpecPathId
Parameters: pipeSpecPathId (str) – New in version NX11.0.1.
License requirements: None.
Method Detail¶
AutoAssignAttributes¶
-
RunBuilder.
AutoAssignAttributes
¶ Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
Signature
AutoAssignAttributes(objects)
Parameters: objects (list of NXOpen.NXObject
) –Returns: Return type: NXOpen.ErrorList
New in version NX8.5.0.
License requirements: None.
AutoAssignAttributesWithNamingPattern¶
-
RunBuilder.
AutoAssignAttributesWithNamingPattern
¶ Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.
properties needs to be created using
CreateAttributeTitleToNamingPatternMap()
Signature
AutoAssignAttributesWithNamingPattern(objects, properties)
Parameters: - objects (list of
NXOpen.NXObject
) – - properties (list of
NXOpen.NXObject
) –
Returns: Return type: New in version NX12.0.0.
License requirements: None.
- objects (list of
CreateAttributeTitleToNamingPatternMap¶
-
RunBuilder.
CreateAttributeTitleToNamingPatternMap
¶ Creates a map object of attribute titles to their corresponding naming pattern
Signature
CreateAttributeTitleToNamingPatternMap(attributeTitles, titlePatterns)
Parameters: - attributeTitles (list of str) –
- titlePatterns (list of str) –
Returns: Return type: New in version NX12.0.0.
License requirements: None.
GetLogicalObject¶
-
RunBuilder.
GetLogicalObject
¶ Gets the known logical object.
Signature
GetLogicalObject()
Returns: Return type: NXOpen.PDM.LogicalObject
New in version NX11.0.1.
License requirements: None.
Validate¶
-
RunBuilder.
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.