PostGraphAlongPathBuilder Class¶
-
class
NXOpen.CAE.PostGraphAlongPathBuilder¶ Bases:
NXOpen.CAE.PostGraphBuilderRepresents a
NXOpen.CAE.PostGraphAlongPathBuilderThis is an abstract class and cannot be instantiated
Default values.
Property Value QueryCurveUsageOptions.CurveUsage UseVertices QueryCurveUsageOptions.DistanceTolerance 0 QueryCurveUsageOptions.ResultantCurveLocator UseAsIs QueryCurveUsageOptions.ResultantLocationTolerance 0 New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| ComplexGraphTypes | Returns or sets the complex plot display option while plotting complex result type |
| CreateFieldOption | Returns or sets the option to create field of the across iteration graph created by expression |
| CsysAxis | Returns or sets the option to define the coordinate system axis to be used when x axis defined by NXOpen.CAE.PostGraphAlongPathBuilderXaxis.CoordinateValueOfCoordinateSystemAxis |
| DefineByPathOption | Returns or sets a value indicating whether the x axis is define by a path ID. |
| EdgeIntegralOptionValue | Returns or sets the weighted average or integral option on selecting Edge |
| EvalutionErrorsOption | Returns or sets the error handling option when there are evaluation errors on selected entities or path |
| FaceIntegralOptionValue | Returns or sets the weighted average or integral option on selecting Face |
| GeometryCombinationValue | Returns or sets the geometry value option in case of edge, face or body selection |
| GraphTitle | Returns or sets the graph title |
| IncludeItersectionsOption | Returns or sets the value indicating whether to include intersections points while defining the x axis along the path |
| IncompatibleResultOption | Returns or sets the error handling option when results are not compatible on selected entities or path |
| NoDataOption | Returns or sets the error handling option when result is not present on selected entities or path |
| NodalCombinationValue | Returns or sets the nodal combination option for determining the nodal value for element and element-nodal results |
| PathId | Returns or sets the path id to define the x axis with path |
| QueryCurveUsageOptions | Returns the query curve usage options |
| SaveAfuOption | Returns or sets the save in AFU option to save graph data as AFU records |
| SelectedEntityType | Returns or sets the entity type of the tags of entities which passed using SetEntityObjects function |
| Tag | Returns the Tag for this object. |
| UserData | Returns or sets the error handling value used when error occurs or no data present on entities |
| XaxisOption | Returns or sets the option for defining the x axis of the graph. |
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. |
| GetFieldTable | Gets the field which is created when user sets the NXOpen.CAE.PostGraphBuilder.CreateFieldOption`() to true for across iterations type of graphs |
| GetObject | Returns the object currently being edited by this builder. |
| SetCsys | Set csys for extracting data for x axis |
| SetCsysType | Sets csys type for extracting abscissa |
| SetEntityIds | Set entity ids for extracting result data |
| SetEntityObjects | Sets the entity objects for extracting result data. |
| SetFreePoints | Set free points for extracting data |
| SetOrigin | Set vector origin for extracting data for x axis |
| SetSelectionEntityObjects | Sets the selection entity object. |
| SetVector | Set vector for extracting data for x axis |
| 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. |
Enumerations¶
| PostGraphAlongPathBuilderCoordinateSysAxis Enumeration | options for defining the specific coordinate system axis to be used |
| PostGraphAlongPathBuilderCsysType Enumeration | csys types |
| PostGraphAlongPathBuilderXaxis Enumeration | select option to define the path as x axis |
Property Detail¶
CsysAxis¶
-
PostGraphAlongPathBuilder.CsysAxis¶ Returns or sets the option to define the coordinate system axis to be used when x axis defined by
NXOpen.CAE.PostGraphAlongPathBuilderXaxis.CoordinateValueOfCoordinateSystemAxis-------------------------------------Getter Method
Signature
CsysAxisReturns: Return type: NXOpen.CAE.PostGraphAlongPathBuilderCoordinateSysAxisNew 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
CsysAxisParameters: axis ( NXOpen.CAE.PostGraphAlongPathBuilderCoordinateSysAxis) –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”)
DefineByPathOption¶
-
PostGraphAlongPathBuilder.DefineByPathOption¶ Returns or sets a value indicating whether the x axis is define by a path ID.
If true, you need to set
NXOpen.CAE.PostGraphAlongPathBuilder.PathId`()-------------------------------------Getter Method
Signature
DefineByPathOptionReturns: Return type: bool 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
DefineByPathOptionParameters: defineByPath (bool) – 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”)
IncludeItersectionsOption¶
-
PostGraphAlongPathBuilder.IncludeItersectionsOption¶ Returns or sets the value indicating whether to include intersections points while defining the x axis along the path
-------------------------------------Getter Method
Signature
IncludeItersectionsOptionReturns: Return type: bool 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
IncludeItersectionsOptionParameters: includeItersections (bool) – 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”)
PathId¶
-
PostGraphAlongPathBuilder.PathId¶ Returns or sets the path id to define the x axis with path
-------------------------------------Getter Method
Signature
PathIdReturns: Return type: 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”)
-------------------------------------Setter Method
Signature
PathIdParameters: pathId (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”)
QueryCurveUsageOptions¶
-
PostGraphAlongPathBuilder.QueryCurveUsageOptions¶ Returns the query curve usage options
-------------------------------------Getter Method
Signature
QueryCurveUsageOptionsReturns: query curve options Return type: NXOpen.CAE.QueryCurveUsageOptionsNew in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”) OR sc_results_viewer (” Simcenter Results Viewer”)
XaxisOption¶
-
PostGraphAlongPathBuilder.XaxisOption¶ Returns or sets the option for defining the x axis of the graph.
If the option
NXOpen.CAE.PostGraphAlongPathBuilderXaxis.CoordinateValueOfCoordinateSystemAxisis set useNXOpen.CAE.PostGraphAlongPathBuilder.SetCsys(),NXOpen.CAE.PostGraphAlongPathBuilder.SetCsysType()needs to be used to specify csys and csys type and useNXOpen.CAE.PostGraphAlongPathBuilder.CsysAxis`()If the optionNXOpen.CAE.PostGraphAlongPathBuilderXaxis.LengthAlongDirectionis set useNXOpen.CAE.PostGraphAlongPathBuilder.SetOrigin(),NXOpen.CAE.PostGraphAlongPathBuilder.SetVector()need to be used to specify vector along which length of the path points will be calculated-------------------------------------Getter Method
Signature
XaxisOptionReturns: Return type: NXOpen.CAE.PostGraphAlongPathBuilderXaxisNew 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
XaxisOptionParameters: xaxis ( NXOpen.CAE.PostGraphAlongPathBuilderXaxis) –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¶
SetCsys¶
-
PostGraphAlongPathBuilder.SetCsys¶ Set csys for extracting data for x axis
Signature
SetCsys(csys)Parameters: csys ( NXOpen.Matrix3x3) –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”)
SetCsysType¶
-
PostGraphAlongPathBuilder.SetCsysType¶ Sets csys type for extracting abscissa
Signature
SetCsysType(csystype)Parameters: csystype ( NXOpen.CAE.PostGraphAlongPathBuilderCsysType) – set csys typeNew 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”)
SetOrigin¶
-
PostGraphAlongPathBuilder.SetOrigin¶ Set vector origin for extracting data for x axis
Signature
SetOrigin(origin)Parameters: origin ( 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”)
SetVector¶
-
PostGraphAlongPathBuilder.SetVector¶ Set vector for extracting data for x axis
Signature
SetVector(unitvector)Parameters: unitvector ( 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”)
Validate¶
-
PostGraphAlongPathBuilder.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.