NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::PostGraphBuilder Class Reference

Represents a NXOpen::CAE::PostGraphBuilder
This is an abstract class and cannot be instantiated

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::CAE::PostGraphBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAE::Post3DGraphBuilder NXOpen::CAE::PostGraphAcrossIterationsBuilder NXOpen::CAE::PostGraphAlongPathBuilder

Public Types

enum  DataErrorHandling { DataErrorHandlingSkip, DataErrorHandlingUserValue }
 error handling option when result values are not present for the selected entities More...
 
enum  EdgeIntegralOption { EdgeIntegralOptionLength, EdgeIntegralOptionArea }
 weighted Average / Integral calculation based on weighted average by on selection of Edge More...
 
enum  EntityType {
  EntityTypeNode, EntityTypeElement, EntityTypePoint, EntityTypeEdge,
  EntityTypeFace, EntityTypeBody
}
 types of the entity objects which are selected More...
 
enum  EvalutionErrors { EvalutionErrorsSkip, EvalutionErrorsUserValue, EvalutionErrorsAbort }
 error handling option when there are expression evaluation errors while evaluating the formula More...
 
enum  FaceIntegralOption { FaceIntegralOptionArea, FaceIntegralOptionVolume }
 weighted Average/ Integral calculation based on weighted average by on selection of Face More...
 
enum  GeometryValue {
  GeometryValueAverage, GeometryValueMinimum, GeometryValueMaximum, GeometryValueSum,
  GeometryValueWeightedAverage, GeometryValueIntegral
}
 This option is used to when the geometric entity selected has multiple result values. More...
 
enum  IncompatibleResult { IncompatibleResultSkip, IncompatibleResultAbort }
 error handling option when incompactible results are selected More...
 
enum  NodalCombination {
  NodalCombinationAverage, NodalCombinationMinimum, NodalCombinationMaximum, NodalCombinationSum,
  NodalCombinationNone
}
 nodal combination option for determining the nodal result value for element and element-nodal result More...
 

Public Member Functions

NXOpen::CAE::Xyplot::ComplexOption2D ComplexGraphTypes ()
 Returns the complex plot display option while plotting complex result type
Created in NX9.0.0. More...
 
bool CreateFieldOption ()
 Returns the option to create field of the across iteration graph created by expression
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::EdgeIntegralOption EdgeIntegralOptionValue ()
 Returns the weighted average or integral option on selecting Edge
Created in NX10.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::EvalutionErrors EvalutionErrorsOption ()
 Returns the error handling option when there are evaluation errors on selected entities or path
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::FaceIntegralOption FaceIntegralOptionValue ()
 Returns the weighted average or integral option on selecting Face
Created in NX10.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::GeometryValue GeometryCombinationValue ()
 Returns the geometry value option in case of edge, face or body selection
Created in NX9.0.0. More...
 
NXOpen::Fields::FieldTableGetFieldTable ()
 Gets the field which is created when user sets the NXOpen::CAE::PostGraphBuilder::CreateFieldOption and NXOpen::CAE::PostGraphBuilder::SetCreateFieldOption to true for across iterations type of graphs. More...
 
NXString GraphTitle ()
 Returns the graph title
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::IncompatibleResult IncompatibleResultOption ()
 Returns the error handling option when results are not compatible on selected entities or path
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::NodalCombination NodalCombinationValue ()
 Returns the nodal combination option for determining the nodal value for element and element-nodal results
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::DataErrorHandling NoDataOption ()
 Returns the error handling option when result is not present on selected entities or path
Created in NX9.0.0. More...
 
bool SaveAfuOption ()
 Returns the save in AFU option to save graph data as AFU records
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphBuilder::EntityType SelectedEntityType ()
 Returns the entity type of the tags of entities which passed using SetEntityObjects function
Created in NX9.0.0. More...
 
void SetComplexGraphTypes (NXOpen::CAE::Xyplot::ComplexOption2D complexGraphTypes)
 Sets the complex plot display option while plotting complex result type
Created in NX9.0.0. More...
 
void SetCreateFieldOption (bool createField)
 Sets the option to create field of the across iteration graph created by expression
Created in NX9.0.0. More...
 
void SetEdgeIntegralOptionValue (NXOpen::CAE::PostGraphBuilder::EdgeIntegralOption edgeIntegralOption)
 Sets the weighted average or integral option on selecting Edge
Created in NX10.0.0. More...
 
void SetEntityIds (bool isnodal, const std::vector< int > &entityIds)
 Set entity ids for extracting result data
Created in NX9.0.0. More...
 
void SetEntityObjects (const std::vector< NXOpen::TaggedObject * > &entityObjs)
 Sets the entity objects for extracting result data. More...
 
void SetEvalutionErrorsOption (NXOpen::CAE::PostGraphBuilder::EvalutionErrors evalutionErrorsOption)
 Sets the error handling option when there are evaluation errors on selected entities or path
Created in NX9.0.0. More...
 
void SetFaceIntegralOptionValue (NXOpen::CAE::PostGraphBuilder::FaceIntegralOption faceIntegralOption)
 Sets the weighted average or integral option on selecting Face
Created in NX10.0.0. More...
 
void SetFreePoints (const std::vector< NXOpen::Point3d > &freePoints)
 Set free points for extracting data
Created in NX9.0.0. More...
 
void SetGeometryCombinationValue (NXOpen::CAE::PostGraphBuilder::GeometryValue geometryValue)
 Sets the geometry value option in case of edge, face or body selection
Created in NX9.0.0. More...
 
void SetGraphTitle (const NXString &graphTitle)
 Sets the graph title
Created in NX9.0.0. More...
 
void SetGraphTitle (const char *graphTitle)
 Sets the graph title
Created in NX9.0.0. More...
 
void SetIncompatibleResultOption (NXOpen::CAE::PostGraphBuilder::IncompatibleResult incompatibleResult)
 Sets the error handling option when results are not compatible on selected entities or path
Created in NX9.0.0. More...
 
void SetNodalCombinationValue (NXOpen::CAE::PostGraphBuilder::NodalCombination nodalValue)
 Sets the nodal combination option for determining the nodal value for element and element-nodal results
Created in NX9.0.0. More...
 
void SetNoDataOption (NXOpen::CAE::PostGraphBuilder::DataErrorHandling noDataOption)
 Sets the error handling option when result is not present on selected entities or path
Created in NX9.0.0. More...
 
void SetSaveAfuOption (bool saveAFU)
 Sets the save in AFU option to save graph data as AFU records
Created in NX9.0.0. More...
 
void SetSelectedEntityType (NXOpen::CAE::PostGraphBuilder::EntityType geometryEntity)
 Sets the entity type of the tags of entities which passed using SetEntityObjects function
Created in NX9.0.0. More...
 
void SetSelectionEntityObjects (const std::vector< NXOpen::CAE::PostSelectionEntity * > &selectionEntities)
 Sets the selection entity object. More...
 
void SetUserData (double userDataOption)
 Sets the error handling value used when error occurs or no data present on entities
Created in NX9.0.0. More...
 
double UserData ()
 Returns the error handling value used when error occurs or no data present on entities
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::CAE::PostGraphBuilder
This is an abstract class and cannot be instantiated

Created in NX9.0.0.


Member Enumeration Documentation

error handling option when result values are not present for the selected entities

Enumerator
DataErrorHandlingSkip 

skip

DataErrorHandlingUserValue 

User given value will used for those entities which do not have result value associated with them.

weighted Average / Integral calculation based on weighted average by on selection of Edge

Enumerator
EdgeIntegralOptionLength 

length

EdgeIntegralOptionArea 

area

types of the entity objects which are selected

Enumerator
EntityTypeNode 

node

EntityTypeElement 

element

EntityTypePoint 

point

EntityTypeEdge 

edge

EntityTypeFace 

face

EntityTypeBody 

body

error handling option when there are expression evaluation errors while evaluating the formula

Enumerator
EvalutionErrorsSkip 

skip

EvalutionErrorsUserValue 

user value

EvalutionErrorsAbort 

abort

weighted Average/ Integral calculation based on weighted average by on selection of Face

Enumerator
FaceIntegralOptionArea 

area

FaceIntegralOptionVolume 

volume

This option is used to when the geometric entity selected has multiple result values.

This option applies to how we will resolve these multiple values into one

Enumerator
GeometryValueAverage 

average

GeometryValueMinimum 

minimum

GeometryValueMaximum 

maximum

GeometryValueSum 

sum

GeometryValueWeightedAverage 

weighted average

GeometryValueIntegral 

integral

error handling option when incompactible results are selected

Enumerator
IncompatibleResultSkip 

skip

IncompatibleResultAbort 

abort

nodal combination option for determining the nodal result value for element and element-nodal result

Enumerator
NodalCombinationAverage 

average

NodalCombinationMinimum 

minimum

NodalCombinationMaximum 

maximum

NodalCombinationSum 

sum

NodalCombinationNone 

none

Member Function Documentation

NXOpen::CAE::Xyplot::ComplexOption2D NXOpen::CAE::PostGraphBuilder::ComplexGraphTypes ( )

Returns the complex plot display option while plotting complex result type
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

bool NXOpen::CAE::PostGraphBuilder::CreateFieldOption ( )

Returns the option to create field of the across iteration graph created by expression
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::EdgeIntegralOption NXOpen::CAE::PostGraphBuilder::EdgeIntegralOptionValue ( )

Returns the weighted average or integral option on selecting Edge
Created in NX10.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::EvalutionErrors NXOpen::CAE::PostGraphBuilder::EvalutionErrorsOption ( )

Returns the error handling option when there are evaluation errors on selected entities or path
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::FaceIntegralOption NXOpen::CAE::PostGraphBuilder::FaceIntegralOptionValue ( )

Returns the weighted average or integral option on selecting Face
Created in NX10.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::GeometryValue NXOpen::CAE::PostGraphBuilder::GeometryCombinationValue ( )

Returns the geometry value option in case of edge, face or body selection
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::Fields::FieldTable* NXOpen::CAE::PostGraphBuilder::GetFieldTable ( )

Gets the field which is created when user sets the NXOpen::CAE::PostGraphBuilder::CreateFieldOption and NXOpen::CAE::PostGraphBuilder::SetCreateFieldOption to true for across iterations type of graphs.

Returns
field
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")
NXString NXOpen::CAE::PostGraphBuilder::GraphTitle ( )

Returns the graph title
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::IncompatibleResult NXOpen::CAE::PostGraphBuilder::IncompatibleResultOption ( )

Returns the error handling option when results are not compatible on selected entities or path
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::NodalCombination NXOpen::CAE::PostGraphBuilder::NodalCombinationValue ( )

Returns the nodal combination option for determining the nodal value for element and element-nodal results
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::DataErrorHandling NXOpen::CAE::PostGraphBuilder::NoDataOption ( )

Returns the error handling option when result is not present on selected entities or path
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

bool NXOpen::CAE::PostGraphBuilder::SaveAfuOption ( )

Returns the save in AFU option to save graph data as AFU records
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

NXOpen::CAE::PostGraphBuilder::EntityType NXOpen::CAE::PostGraphBuilder::SelectedEntityType ( )

Returns the entity type of the tags of entities which passed using SetEntityObjects function
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

void NXOpen::CAE::PostGraphBuilder::SetComplexGraphTypes ( NXOpen::CAE::Xyplot::ComplexOption2D  complexGraphTypes)

Sets the complex plot display option while plotting complex result type
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
complexGraphTypescomplexgraphtypes
void NXOpen::CAE::PostGraphBuilder::SetCreateFieldOption ( bool  createField)

Sets the option to create field of the across iteration graph created by expression
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
createFieldcreatefield
void NXOpen::CAE::PostGraphBuilder::SetEdgeIntegralOptionValue ( NXOpen::CAE::PostGraphBuilder::EdgeIntegralOption  edgeIntegralOption)

Sets the weighted average or integral option on selecting Edge
Created in NX10.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
edgeIntegralOptionedgeintegraloption
void NXOpen::CAE::PostGraphBuilder::SetEntityIds ( bool  isnodal,
const std::vector< int > &  entityIds 
)

Set entity ids for extracting result data
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
isnodalisnodal
entityIdsentityids
void NXOpen::CAE::PostGraphBuilder::SetEntityObjects ( const std::vector< NXOpen::TaggedObject * > &  entityObjs)

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 the NXOpen::CAE::PostGraphBuilder::EntityType .


Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
entityObjsentityobjs
void NXOpen::CAE::PostGraphBuilder::SetEvalutionErrorsOption ( NXOpen::CAE::PostGraphBuilder::EvalutionErrors  evalutionErrorsOption)

Sets the error handling option when there are evaluation errors on selected entities or path
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
evalutionErrorsOptionevalutionerrorsoption
void NXOpen::CAE::PostGraphBuilder::SetFaceIntegralOptionValue ( NXOpen::CAE::PostGraphBuilder::FaceIntegralOption  faceIntegralOption)

Sets the weighted average or integral option on selecting Face
Created in NX10.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
faceIntegralOptionfaceintegraloption
void NXOpen::CAE::PostGraphBuilder::SetFreePoints ( const std::vector< NXOpen::Point3d > &  freePoints)

Set free points for extracting data
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
freePointsfreepoints
void NXOpen::CAE::PostGraphBuilder::SetGeometryCombinationValue ( NXOpen::CAE::PostGraphBuilder::GeometryValue  geometryValue)

Sets the geometry value option in case of edge, face or body selection
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
geometryValuegeometryvalue
void NXOpen::CAE::PostGraphBuilder::SetGraphTitle ( const NXString graphTitle)

Sets the graph title
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
graphTitlegraphtitle
void NXOpen::CAE::PostGraphBuilder::SetGraphTitle ( const char *  graphTitle)

Sets the graph title
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
graphTitlegraphtitle
void NXOpen::CAE::PostGraphBuilder::SetIncompatibleResultOption ( NXOpen::CAE::PostGraphBuilder::IncompatibleResult  incompatibleResult)

Sets the error handling option when results are not compatible on selected entities or path
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
incompatibleResultincompatibleresult
void NXOpen::CAE::PostGraphBuilder::SetNodalCombinationValue ( NXOpen::CAE::PostGraphBuilder::NodalCombination  nodalValue)

Sets the nodal combination option for determining the nodal value for element and element-nodal results
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
nodalValuenodalvalue
void NXOpen::CAE::PostGraphBuilder::SetNoDataOption ( NXOpen::CAE::PostGraphBuilder::DataErrorHandling  noDataOption)

Sets the error handling option when result is not present on selected entities or path
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
noDataOptionnodataoption
void NXOpen::CAE::PostGraphBuilder::SetSaveAfuOption ( bool  saveAFU)

Sets the save in AFU option to save graph data as AFU records
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
saveAFUsaveafu
void NXOpen::CAE::PostGraphBuilder::SetSelectedEntityType ( NXOpen::CAE::PostGraphBuilder::EntityType  geometryEntity)

Sets the entity type of the tags of entities which passed using SetEntityObjects function
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
geometryEntitygeometryentity
void NXOpen::CAE::PostGraphBuilder::SetSelectionEntityObjects ( const std::vector< NXOpen::CAE::PostSelectionEntity * > &  selectionEntities)

Sets the selection entity object.


Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
selectionEntitiesNXOpen::CAE::PostSelectionEntity object
void NXOpen::CAE::PostGraphBuilder::SetUserData ( double  userDataOption)

Sets the error handling value used when error occurs or no data present on entities
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
userDataOptionuserdataoption
double NXOpen::CAE::PostGraphBuilder::UserData ( )

Returns the error handling value used when error occurs or no data present on entities
Created in NX9.0.0.



License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.