SinumerikCaPlaceholderBuilder Class¶
-
class
NXOpen.SIM.
SinumerikCaPlaceholderBuilder
¶ Bases:
NXOpen.Builder
This class is used for select or unselect component of the placeholder tools.
A call to
Builder.Commit
on this builder will only return None.Use the
Part
class to create a SinumerikCaPlaceholderBuilder object.New in version NX9.0.0.
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. |
SelectComponent | The select placeholder tools component |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnselectComponent | The select placeholder tools component |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Method Detail¶
SelectComponent¶
-
SinumerikCaPlaceholderBuilder.
SelectComponent
¶ The select placeholder tools component
Signature
SelectComponent(compName)
Parameters: compName (str) – The selected placeholder component name NOTE: The full Unicode character set is not supported for this parameter. New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
UnselectComponent¶
-
SinumerikCaPlaceholderBuilder.
UnselectComponent
¶ The select placeholder tools component
Signature
UnselectComponent(compName)
Parameters: compName (str) – The unselected placeholder component name NOTE: The full Unicode character set is not supported for this parameter. New in version NX9.0.0.
License requirements: nx_sinumerik_ca (“Sinumerik Collision Avoidance”)
Validate¶
-
SinumerikCaPlaceholderBuilder.
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.