PostGraphOrbitBuilder Class¶
-
class
NXOpen.CAE.PostGraphOrbitBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.CAE.PostGraphOrbitBuilderThis is an abstract class and cannot be instantiated
New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| GraphTitle | Returns or sets the graph title |
| Tag | Returns the Tag for this object. |
| XresultComponent | Returns or sets the component used as x axis for orbit plot |
| YresultComponent | Returns or sets the component used as y axis for orbit plot |
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. |
| SetEntityIds | Set entity ids for extracting result data |
| SetFreePoints | Set free points for extracting data |
| SetSelectionEntityObjects | Sets the selection entity object. |
| 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¶
GraphTitle¶
-
PostGraphOrbitBuilder.GraphTitle¶ Returns or sets the graph title
-------------------------------------Getter Method
Signature
GraphTitleReturns: Return type: str New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
-------------------------------------Setter Method
Signature
GraphTitleParameters: stringGraphTitle (str) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
XresultComponent¶
-
PostGraphOrbitBuilder.XresultComponent¶ Returns or sets the component used as x axis for orbit plot
-------------------------------------Getter Method
Signature
XresultComponentReturns: Return type: NXOpen.CAE.ResultComponentNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
-------------------------------------Setter Method
Signature
XresultComponentParameters: xresult ( NXOpen.CAE.ResultComponent) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
YresultComponent¶
-
PostGraphOrbitBuilder.YresultComponent¶ Returns or sets the component used as y axis for orbit plot
-------------------------------------Getter Method
Signature
YresultComponentReturns: Return type: NXOpen.CAE.ResultComponentNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
-------------------------------------Setter Method
Signature
YresultComponentParameters: yresult ( NXOpen.CAE.ResultComponent) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
Method Detail¶
SetEntityIds¶
-
PostGraphOrbitBuilder.SetEntityIds¶ Set entity ids for extracting result data
Signature
SetEntityIds(entityIds)Parameters: entityIds (list of int) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
SetFreePoints¶
-
PostGraphOrbitBuilder.SetFreePoints¶ Set free points for extracting data
Signature
SetFreePoints(freePoints)Parameters: freePoints (list of NXOpen.Point3d) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
SetSelectionEntityObjects¶
-
PostGraphOrbitBuilder.SetSelectionEntityObjects¶ Sets the selection entity object.
Signature
SetSelectionEntityObjects(selectionEntities)Parameters: selectionEntities (list of NXOpen.CAE.PostSelectionEntity) –NXOpen.CAE.PostSelectionEntityobjectNew in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
Validate¶
-
PostGraphOrbitBuilder.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.