LayoutStateApplicator Class¶
-
class
NXOpen.CAE.
LayoutStateApplicator
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.CAE.LayoutStateApplicator
which can be used to visualize a layout state.Not support KF.
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
Tag | Returns the Tag for this object. |
DataReferences | Contains a NXOpen.CAE.LayoutStateDataReferenceCollection . |
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. |
GetUpdateLayoutState | Gets the update layout state flag. |
SetFile | Sets the exported layout state that will be applied. |
SetLayoutState | Sets the layout state that will be applied. |
SetUpdateLayoutState | Sets the update layout state flag. |
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. |
DataReferences¶
-
LayoutStateApplicator.
DataReferences
¶ Contains a
NXOpen.CAE.LayoutStateDataReferenceCollection
.Signature
DataReferences
New in version NX11.0.0.
Returns: Return type: NXOpen.CAE.LayoutStateDataReferenceCollection
Method Detail¶
GetUpdateLayoutState¶
-
LayoutStateApplicator.
GetUpdateLayoutState
¶ Gets the update layout state flag.
If true, the layout state data references are updated during the commit method. Otherwise, the layout state data references remain unchanged.
Signature
GetUpdateLayoutState()
Returns: Return type: bool New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetFile¶
-
LayoutStateApplicator.
SetFile
¶ Sets the exported layout state that will be applied.
Signature
SetFile(filePath)
Parameters: filePath (str) – New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetLayoutState¶
-
LayoutStateApplicator.
SetLayoutState
¶ Sets the layout state that will be applied.
Signature
SetLayoutState(layoutState)
Parameters: layoutState ( NXOpen.CAE.LayoutState
) –New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetUpdateLayoutState¶
-
LayoutStateApplicator.
SetUpdateLayoutState
¶ Sets the update layout state flag.
If true, the layout state data references are updated during the commit method. Otherwise, the layout state data references remain unchanged.
Signature
SetUpdateLayoutState(update)
Parameters: update (bool) – New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Validate¶
-
LayoutStateApplicator.
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.