   Represents a @link CAE::PostGraphAlongPathBuilder CAE::PostGraphAlongPathBuilder@endlink 
<br> This is an abstract class and cannot be instantiated  <br>

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::CAE::PostGraphAlongPathBuilder:

Public Types
enum	CoordinateSysAxis { CoordinateSysAxisFirstAxis, CoordinateSysAxisSecondAxis, CoordinateSysAxisThirdAxis }
	options for defining the specific coordinate system axis to be used More...

enum	CsysType { CsysTypeCartesian, CsysTypeCylindrical, CsysTypeSpherical }
	csys types More...

enum	Xaxis { XaxisIDs, XaxisPathLength, XaxisLengthAlongDirection, XaxisCoordinateValueOfCoordinateSystemAxis }
	select option to define the path as x axis 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	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	GeometryValue { GeometryValueAverage, GeometryValueMinimum, GeometryValueMaximum, GeometryValueSum }
	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::PostGraphAlongPathBuilder::CoordinateSysAxis	CsysAxis ()
	Returns the option to define the coordinate system axis to be used when x axis defined by CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis Created in NX9.0.0.

bool	DefineByPathOption ()
	Returns a value indicating whether the x axis is define by a path ID.

bool	IncludeItersectionsOption ()
	Returns the value indicating whether to include intersections points while defining the x axis along the path Created in NX9.0.0.

int	PathId ()
	Returns the path id to define the x axis with path Created in NX9.0.0.

void	SetCsys (const NXOpen::Matrix3x3 &csys)
	Set csys for extracting data for x axis Created in NX9.0.0.

void	SetCsysAxis (NXOpen::CAE::PostGraphAlongPathBuilder::CoordinateSysAxis axis)
	Sets the option to define the coordinate system axis to be used when x axis defined by CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis Created in NX9.0.0.

void	SetCsysType (NXOpen::CAE::PostGraphAlongPathBuilder::CsysType csystype)
	Sets csys type for extracting abscissa Created in NX9.0.0.

void	SetDefineByPathOption (bool defineByPath)
	Sets a value indicating whether the x axis is define by a path ID.

void	SetIncludeItersectionsOption (bool includeItersections)
	Sets the value indicating whether to include intersections points while defining the x axis along the path Created in NX9.0.0.

void	SetOrigin (const NXOpen::Point3d &origin)
	Set vector origin for extracting data for x axis Created in NX9.0.0.

void	SetPathId (int pathId)
	Sets the path id to define the x axis with path Created in NX9.0.0.

void	SetVector (const NXOpen::Point3d &unitvector)
	Set vector for extracting data for x axis Created in NX9.0.0.

void	SetXaxisOption (NXOpen::CAE::PostGraphAlongPathBuilder::Xaxis xaxis)
	Sets the option for defining the x axis of the graph.

NXOpen::CAE::PostGraphAlongPathBuilder::Xaxis	XaxisOption ()
	Returns the option for defining the x axis of the graph.

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.

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

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.

NXOpen::CAE::PostGraphBuilder::GeometryValue	GeometryCombinationValue ()
	Returns the geometry value option in case of edge, face or body selection Created in NX9.0.0.

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

NXString	GraphTitle ()
	Returns the graph title Created in NX9.0.0.

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.

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.

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.

bool	SaveAfuOption ()
	Returns the save in AFU option to save graph data as AFU records Created in NX9.0.0.

NXOpen::CAE::PostGraphBuilder::EntityType	SelectedEntityType ()
	Returns the entity type of the tags of entities which passed using SetEntityObjects function Created in NX9.0.0.

void	SetComplexGraphTypes (NXOpen::CAE::Xyplot::ComplexOption2D complexGraphTypes)
	Sets the complex plot display option while plotting complex result type Created in NX9.0.0.

void	SetCreateFieldOption (bool createField)
	Sets the option to create field of the across iteration graph created by expression Created in NX9.0.0.

void	SetEntityIds (bool isnodal, const std::vector< int > &entityIds)
	Set entity ids for extracting result data Created in NX9.0.0.

void	SetEntityObjects (const std::vector< NXOpen::TaggedObject * > &entityObjs)
	Sets the entity objects for extracting result data.

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.

void	SetFreePoints (const std::vector< NXOpen::Point3d > &freePoints)
	Set free points for extracting data Created in NX9.0.0.

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.

void	SetGraphTitle (const NXString &graphTitle)
	Sets the graph title Created in NX9.0.0.

void	SetGraphTitle (const char *graphTitle)
	Sets the graph title Created in NX9.0.0.

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.

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.

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.

void	SetSaveAfuOption (bool saveAFU)
	Sets the save in AFU option to save graph data as AFU records Created in NX9.0.0.

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.

void	SetUserData (double userDataOption)
	Sets the error handling value used when error occurs or no data present on entities Created in NX9.0.0.

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

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

   Represents a @link CAE::PostGraphAlongPathBuilder CAE::PostGraphAlongPathBuilder@endlink 
<br> This is an abstract class and cannot be instantiated  <br>

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::PostGraphAlongPathBuilder::CoordinateSysAxis

options for defining the specific coordinate system axis to be used

Enumerator:

CoordinateSysAxisFirstAxis	first axis
CoordinateSysAxisSecondAxis	second axis
CoordinateSysAxisThirdAxis	third axis

enum NXOpen::CAE::PostGraphAlongPathBuilder::CsysType

csys types

Enumerator:

CsysTypeCartesian	cartesian
CsysTypeCylindrical	cylindrical
CsysTypeSpherical	spherical

enum NXOpen::CAE::PostGraphAlongPathBuilder::Xaxis

select option to define the path as x axis

Enumerator:

XaxisIDs	ids
XaxisPathLength	path length
XaxisLengthAlongDirection	length along direction
XaxisCoordinateValueOfCoordinateSystemAxis	coordinate value of coordinate system axis

Member Function Documentation

NXOpen::CAE::PostGraphAlongPathBuilder::CoordinateSysAxis NXOpen::CAE::PostGraphAlongPathBuilder::CsysAxis ( )

Returns the option to define the coordinate system axis to be used when x axis defined by CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::PostGraphAlongPathBuilder::DefineByPathOption ( )

Returns a value indicating whether the x axis is define by a path ID.

If true, you need to set CAE::PostGraphAlongPathBuilder::PathId and CAE::PostGraphAlongPathBuilder::SetPathId
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::PostGraphAlongPathBuilder::IncludeItersectionsOption ( )

Returns the value indicating whether to include intersections points while defining the x axis along the path
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

int NXOpen::CAE::PostGraphAlongPathBuilder::PathId ( )

Returns the path id to define the x axis with path
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::PostGraphAlongPathBuilder::SetCsys ( const NXOpen::Matrix3x3 & csys )

Set csys for extracting data for x axis
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

csys csys

void NXOpen::CAE::PostGraphAlongPathBuilder::SetCsysAxis ( NXOpen::CAE::PostGraphAlongPathBuilder::CoordinateSysAxis axis )

Sets the option to define the coordinate system axis to be used when x axis defined by CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

axis axis

void NXOpen::CAE::PostGraphAlongPathBuilder::SetCsysType ( NXOpen::CAE::PostGraphAlongPathBuilder::CsysType csystype )

Sets csys type for extracting abscissa
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

csystype set csys type

void NXOpen::CAE::PostGraphAlongPathBuilder::SetDefineByPathOption ( bool defineByPath )

Sets a value indicating whether the x axis is define by a path ID.

If true, you need to set CAE::PostGraphAlongPathBuilder::PathId and CAE::PostGraphAlongPathBuilder::SetPathId
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

defineByPath definebypath

void NXOpen::CAE::PostGraphAlongPathBuilder::SetIncludeItersectionsOption ( bool includeItersections )

Sets the value indicating whether to include intersections points while defining the x axis along the path
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

includeItersections includeitersections

void NXOpen::CAE::PostGraphAlongPathBuilder::SetOrigin ( const NXOpen::Point3d & origin )

Set vector origin for extracting data for x axis
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

origin origin

void NXOpen::CAE::PostGraphAlongPathBuilder::SetPathId ( int pathId )

Sets the path id to define the x axis with path
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

pathId pathid

void NXOpen::CAE::PostGraphAlongPathBuilder::SetVector ( const NXOpen::Point3d & unitvector )

Set vector for extracting data for x axis
Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

unitvector unitvector

void NXOpen::CAE::PostGraphAlongPathBuilder::SetXaxisOption ( NXOpen::CAE::PostGraphAlongPathBuilder::Xaxis xaxis )

Sets the option for defining the x axis of the graph.

       If the option @link CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis@endlink  is set use
       @link CAE::PostGraphAlongPathBuilder::SetCsys CAE::PostGraphAlongPathBuilder::SetCsys@endlink , @link CAE::PostGraphAlongPathBuilder::SetCsysType CAE::PostGraphAlongPathBuilder::SetCsysType@endlink  
       needs to be used to specify csys and csys type and use @link CAE::PostGraphAlongPathBuilder::CsysAxis CAE::PostGraphAlongPathBuilder::CsysAxis @endlink and @link CAE::PostGraphAlongPathBuilder::SetCsysAxis CAE::PostGraphAlongPathBuilder::SetCsysAxis @endlink  
       If the option @link CAE::PostGraphAlongPathBuilder::XaxisLengthAlongDirection CAE::PostGraphAlongPathBuilder::XaxisLengthAlongDirection@endlink  is set use
       @link CAE::PostGraphAlongPathBuilder::SetOrigin CAE::PostGraphAlongPathBuilder::SetOrigin@endlink , @link CAE::PostGraphAlongPathBuilder::SetVector CAE::PostGraphAlongPathBuilder::SetVector@endlink  
       need to be used to specify vector along which length of the path points will be calculated

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

xaxis xaxis

NXOpen::CAE::PostGraphAlongPathBuilder::Xaxis NXOpen::CAE::PostGraphAlongPathBuilder::XaxisOption ( )

Returns the option for defining the x axis of the graph.

       If the option @link CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis CAE::PostGraphAlongPathBuilder::XaxisCoordinateValueOfCoordinateSystemAxis@endlink  is set use
       @link CAE::PostGraphAlongPathBuilder::SetCsys CAE::PostGraphAlongPathBuilder::SetCsys@endlink , @link CAE::PostGraphAlongPathBuilder::SetCsysType CAE::PostGraphAlongPathBuilder::SetCsysType@endlink  
       needs to be used to specify csys and csys type and use @link CAE::PostGraphAlongPathBuilder::CsysAxis CAE::PostGraphAlongPathBuilder::CsysAxis @endlink and @link CAE::PostGraphAlongPathBuilder::SetCsysAxis CAE::PostGraphAlongPathBuilder::SetCsysAxis @endlink  
       If the option @link CAE::PostGraphAlongPathBuilder::XaxisLengthAlongDirection CAE::PostGraphAlongPathBuilder::XaxisLengthAlongDirection@endlink  is set use
       @link CAE::PostGraphAlongPathBuilder::SetOrigin CAE::PostGraphAlongPathBuilder::SetOrigin@endlink , @link CAE::PostGraphAlongPathBuilder::SetVector CAE::PostGraphAlongPathBuilder::SetVector@endlink  
       need to be used to specify vector along which length of the path points will be calculated

Created in NX9.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

The documentation for this class was generated from the following file:

CAE_PostGraphAlongPathBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation