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

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

Created in NX9.0.0. More...

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

Public Types

enum  CombinationMethod {
  CombinationMethodAverage, CombinationMethodMinimum, CombinationMethodMaximum, CombinationMethodSum,
  CombinationMethodDifference, CombinationMethodWeightedAverage, CombinationMethodIntegral
}
 Defines the methods that can be used to combine multiple values into a single value. More...
 
enum  IterationLabelingOption { IterationLabelingOptionValue, IterationLabelingOptionId }
 Defines the Iteration labeling options. More...
 
- Public Types inherited from NXOpen::CAE::PostGraphBuilder
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

bool CombineAcrossEntities ()
 Returns the combine across entities method to be used if NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombineAcrossEntities and NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetCombineAcrossEntities is True
Created in NX9.0.0. More...
 
NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombinationMethod CombineValueFromEntitiesOption ()
 Returns the set combine across entities option type
Created in NX9.0.0. More...
 
int IterationStepSpacing ()
 Returns the step spacing to be used between the start and end iteration. More...
 
NXOpen::CAE::PostGraphAcrossIterationsBuilder::IterationLabelingOption IterationValueOption ()
 Returns the select iteration type to be set as x axis
Created in NX9.0.0. More...
 
void SetCombineAcrossEntities (bool combineAcrossEntities)
 Sets the combine across entities method to be used if NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombineAcrossEntities and NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetCombineAcrossEntities is True
Created in NX9.0.0. More...
 
void SetCombineValueFromEntitiesOption (NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombinationMethod combineOption)
 Sets the set combine across entities option type
Created in NX9.0.0. More...
 
void SetEndIteration (NXOpen::CAE::BaseIteration *iteration)
 Set end iteration
Created in NX9.0.0. More...
 
void SetIterationStepSpacing (int iterationStepSpacing)
 Sets the step spacing to be used between the start and end iteration. More...
 
void SetIterationValueOption (NXOpen::CAE::PostGraphAcrossIterationsBuilder::IterationLabelingOption iterationValue)
 Sets the select iteration type to be set as x axis
Created in NX9.0.0. More...
 
void SetStartIteration (NXOpen::CAE::BaseIteration *iteration)
 Set start iteration
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::PostGraphBuilder
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::PostGraphAcrossIterationsBuilder
This is an abstract class and cannot be instantiated

Created in NX9.0.0.


Member Enumeration Documentation

Defines the methods that can be used to combine multiple values into a single value.

Enumerator
CombinationMethodAverage 

average

CombinationMethodMinimum 

minimum

CombinationMethodMaximum 

maximum

CombinationMethodSum 

sum

CombinationMethodDifference 

difference

CombinationMethodWeightedAverage 

weighted average

CombinationMethodIntegral 

integral

Defines the Iteration labeling options.

Enumerator
IterationLabelingOptionValue 

value

IterationLabelingOptionId 

id

Member Function Documentation

bool NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombineAcrossEntities ( )

Returns the combine across entities method to be used if NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombineAcrossEntities and NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetCombineAcrossEntities is True
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::PostGraphAcrossIterationsBuilder::CombinationMethod NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombineValueFromEntitiesOption ( )

Returns the set combine across entities option 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")

int NXOpen::CAE::PostGraphAcrossIterationsBuilder::IterationStepSpacing ( )

Returns the step spacing to be used between the start and end iteration.

This option can be used to reduce the amount of data graphed.
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::PostGraphAcrossIterationsBuilder::IterationLabelingOption NXOpen::CAE::PostGraphAcrossIterationsBuilder::IterationValueOption ( )

Returns the select iteration type to be set as x axis
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::PostGraphAcrossIterationsBuilder::SetCombineAcrossEntities ( bool  combineAcrossEntities)

Sets the combine across entities method to be used if NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombineAcrossEntities and NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetCombineAcrossEntities is True
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
combineAcrossEntitiescombineacrossentities
void NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetCombineValueFromEntitiesOption ( NXOpen::CAE::PostGraphAcrossIterationsBuilder::CombinationMethod  combineOption)

Sets the set combine across entities option 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
combineOptioncombineoption
void NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetEndIteration ( NXOpen::CAE::BaseIteration iteration)

Set end iteration
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
iterationiteration
void NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetIterationStepSpacing ( int  iterationStepSpacing)

Sets the step spacing to be used between the start and end iteration.

This option can be used to reduce the amount of data graphed.
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
iterationStepSpacingiterationstepspacing
void NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetIterationValueOption ( NXOpen::CAE::PostGraphAcrossIterationsBuilder::IterationLabelingOption  iterationValue)

Sets the select iteration type to be set as x axis
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
iterationValueiterationvalue
void NXOpen::CAE::PostGraphAcrossIterationsBuilder::SetStartIteration ( NXOpen::CAE::BaseIteration iteration)

Set start iteration
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
iterationiteration

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