PostGraphBuilder Class¶
-
class
NXOpen.CAE.PostGraphBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.CAE.PostGraphBuilderThis is an abstract class and cannot be instantiated
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 |
| 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 |
| 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 |
| 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 |
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 @return field |
| GetObject | Returns the object currently being edited by this builder. |
| SetEntityIds | Set entity ids for extracting result data |
| SetEntityObjects | Sets the entity objects for extracting result data. |
| SetFreePoints | Set free points for extracting data |
| 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¶
| PostGraphBuilderDataErrorHandling Enumeration | error handling option when result values are not present for the selected entities |
| PostGraphBuilderEdgeIntegralOption Enumeration | weighted Average / Integral calculation based on weighted average by on selection of Edge |
| PostGraphBuilderEntityType Enumeration | types of the entity objects which are selected |
| PostGraphBuilderEvalutionErrors Enumeration | error handling option when there are expression evaluation errors while evaluating the formula |
| PostGraphBuilderFaceIntegralOption Enumeration | weighted Average/ Integral calculation based on weighted average by on selection of Face |
| PostGraphBuilderGeometryValue Enumeration | This option is used to when the geometric entity selected has multiple result values. |
| PostGraphBuilderIncompatibleResult Enumeration | error handling option when incompactible results are selected |
| PostGraphBuilderNodalCombination Enumeration | nodal combination option for determining the nodal result value for element and element-nodal result |
Property Detail¶
ComplexGraphTypes¶
-
PostGraphBuilder.ComplexGraphTypes¶ Returns or sets the complex plot display option while plotting complex result type
-------------------------------------Getter Method
Signature
ComplexGraphTypes()Returns: Return type: NXOpen.CAE.Xyplot.ComplexOption2DNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
ComplexGraphTypes(complexGraphTypes)Parameters: complexGraphTypes ( NXOpen.CAE.Xyplot.ComplexOption2D) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
CreateFieldOption¶
-
PostGraphBuilder.CreateFieldOption¶ Returns or sets the option to create field of the across iteration graph created by expression
-------------------------------------Getter Method
Signature
CreateFieldOption()Returns: Return type: bool New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
CreateFieldOption(createField)Parameters: createField (bool) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
EdgeIntegralOptionValue¶
-
PostGraphBuilder.EdgeIntegralOptionValue¶ Returns or sets the weighted average or integral option on selecting Edge
-------------------------------------Getter Method
Signature
EdgeIntegralOptionValue()Returns: Return type: NXOpen.CAE.PostGraphBuilderEdgeIntegralOptionNew in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
EdgeIntegralOptionValue(edgeIntegralOption)Parameters: edgeIntegralOption ( NXOpen.CAE.PostGraphBuilderEdgeIntegralOption) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
EvalutionErrorsOption¶
-
PostGraphBuilder.EvalutionErrorsOption¶ Returns or sets the error handling option when there are evaluation errors on selected entities or path
-------------------------------------Getter Method
Signature
EvalutionErrorsOption()Returns: Return type: NXOpen.CAE.PostGraphBuilderEvalutionErrorsNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
EvalutionErrorsOption(evalutionErrorsOption)Parameters: evalutionErrorsOption ( NXOpen.CAE.PostGraphBuilderEvalutionErrors) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
FaceIntegralOptionValue¶
-
PostGraphBuilder.FaceIntegralOptionValue¶ Returns or sets the weighted average or integral option on selecting Face
-------------------------------------Getter Method
Signature
FaceIntegralOptionValue()Returns: Return type: NXOpen.CAE.PostGraphBuilderFaceIntegralOptionNew in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
FaceIntegralOptionValue(faceIntegralOption)Parameters: faceIntegralOption ( NXOpen.CAE.PostGraphBuilderFaceIntegralOption) –New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GeometryCombinationValue¶
-
PostGraphBuilder.GeometryCombinationValue¶ Returns or sets the geometry value option in case of edge, face or body selection
-------------------------------------Getter Method
Signature
GeometryCombinationValue()Returns: Return type: NXOpen.CAE.PostGraphBuilderGeometryValueNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
GeometryCombinationValue(geometryValue)Parameters: geometryValue ( NXOpen.CAE.PostGraphBuilderGeometryValue) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GraphTitle¶
-
PostGraphBuilder.GraphTitle¶ Returns or sets the graph title
-------------------------------------Getter Method
Signature
GraphTitle()Returns: Return type: str New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
GraphTitle(graphTitle)Parameters: graphTitle (str) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IncompatibleResultOption¶
-
PostGraphBuilder.IncompatibleResultOption¶ Returns or sets the error handling option when results are not compatible on selected entities or path
-------------------------------------Getter Method
Signature
IncompatibleResultOption()Returns: Return type: NXOpen.CAE.PostGraphBuilderIncompatibleResultNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
IncompatibleResultOption(incompatibleResult)Parameters: incompatibleResult ( NXOpen.CAE.PostGraphBuilderIncompatibleResult) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
NoDataOption¶
-
PostGraphBuilder.NoDataOption¶ Returns or sets the error handling option when result is not present on selected entities or path
-------------------------------------Getter Method
Signature
NoDataOption()Returns: Return type: NXOpen.CAE.PostGraphBuilderDataErrorHandlingNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
NoDataOption(noDataOption)Parameters: noDataOption ( NXOpen.CAE.PostGraphBuilderDataErrorHandling) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
NodalCombinationValue¶
-
PostGraphBuilder.NodalCombinationValue¶ Returns or sets the nodal combination option for determining the nodal value for element and element-nodal results
-------------------------------------Getter Method
Signature
NodalCombinationValue()Returns: Return type: NXOpen.CAE.PostGraphBuilderNodalCombinationNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
NodalCombinationValue(nodalValue)Parameters: nodalValue ( NXOpen.CAE.PostGraphBuilderNodalCombination) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SaveAfuOption¶
-
PostGraphBuilder.SaveAfuOption¶ Returns or sets the save in AFU option to save graph data as AFU records
-------------------------------------Getter Method
Signature
SaveAfuOption()Returns: Return type: bool New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
SaveAfuOption(saveAFU)Parameters: saveAFU (bool) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SelectedEntityType¶
-
PostGraphBuilder.SelectedEntityType¶ Returns or sets the entity type of the tags of entities which passed using SetEntityObjects function
-------------------------------------Getter Method
Signature
SelectedEntityType()Returns: Return type: NXOpen.CAE.PostGraphBuilderEntityTypeNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
SelectedEntityType(geometryEntity)Parameters: geometryEntity ( NXOpen.CAE.PostGraphBuilderEntityType) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
UserData¶
-
PostGraphBuilder.UserData¶ Returns or sets the error handling value used when error occurs or no data present on entities
-------------------------------------Getter Method
Signature
UserData()Returns: Return type: float New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
UserData(userDataOption)Parameters: userDataOption (float) – New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Method Detail¶
GetFieldTable¶
-
PostGraphBuilder.GetFieldTable¶ Gets the field which is created when user sets the
NXOpen.CAE.PostGraphBuilder.CreateFieldOption`()to true for across iterations type of graphsSignature
GetFieldTable()Returns: field Return type: NXOpen.Fields.FieldTableNew in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetEntityIds¶
-
PostGraphBuilder.SetEntityIds¶ Set entity ids for extracting result data
Signature
SetEntityIds(isnodal, entityIds)Parameters: - isnodal (bool) –
- entityIds (list of int) –
New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetEntityObjects¶
-
PostGraphBuilder.SetEntityObjects¶ Sets the entity objects for extracting result data.
Objects passed to this method are of the type defined by
NXOpen.CAE.PostGraphBuilder.SelectedEntityType(). The types of objects allowed to be set are is defined by theNXOpen.CAE.PostGraphBuilderEntityType.Signature
SetEntityObjects(entityObjs)Parameters: entityObjs (list of NXOpen.TaggedObject) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetFreePoints¶
-
PostGraphBuilder.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”)
Validate¶
-
PostGraphBuilder.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.