Represents a specific result state for a given CAE::Result . More...

Inheritance diagram for NXOpen::CAE::ResultAccess:

Public Member Functions
NXOpen::CAE::Result::DataType	AskCurrentResultDataType ()
	Returns the result type for the current result state defined by CAE::ResultParameters.

void	AskElementNodalResult (int elementIndex, std::vector< int > &nodeLabels, std::vector< double > &value)
	Ask element nodal result at a specified element index Created in NX6.0.2.

void	AskElementNodalResultAllComponents (int elementIndex, std::vector< int > &nodeIndex, int *numComponents, std::vector< double > &value)
	Ask element nodal result at a specified element index Use CAE::ResultAccess::AskResultComponents to query type of components All values will be returned as a single dimensional array.

double	AskElementResult (int elementIndex)
	Ask current component value at a specified element index.

std::vector< double >	AskElementResult (const std::vector< int > &elementIndices)
	Ask current component value at a specified element indices.

void	AskElementResultAllComponents (int elementIndex, std::vector< double > &value)
	Ask all component values at a specified element index Use CAE::ResultAccess::AskResultComponents to query type of components Created in NX6.0.2.

double	AskMaximum ()
	Ask maximum value of current result state defined by CAE::ResultParameters.

double	AskMinimum ()
	Ask minimum value of current result state defined by CAE::ResultParameters.

void	AskMinMaxLocation (NXOpen::CAE::Result::Location location, double min, double max, int minID, int maxID, int minSubID, int *maxSubID)
	Ask Min and Max value of current result state defined by CAE::ResultParameters If the CAE::Result::Location is nodal or elemental then ID will be node and element respectively.

void	AskNMinMaxLocation (int numExtreme, NXOpen::CAE::Result::Location *location, std::vector< double > &min, std::vector< double > &max, std::vector< int > &minID, std::vector< int > &minSubID, std::vector< int > &maxID, std::vector< int > &maxSubID)
	Ask for the N extreme Min and Max values and the location of current result state defined by CAE::ResultParameters .

double	AskNodalResult (int nodeIndex)
	Ask current component value at a specified node index.

std::vector< double >	AskNodalResult (const std::vector< int > &nodeIndices)
	Ask current component value at a specified node indices.

void	AskNodalResultAllComponents (int nodeIndex, std::vector< double > &value)
	Ask all component values at a specified node index Use CAE::ResultAccess::AskResultComponents to query type of components Created in NX6.0.2.

double	AskResultAtLocation (const NXOpen::Point3d &location)
	Ask current component value at a specified location.

void	AskResultAtLocationAllComponents (const NXOpen::Point3d &position, std::vector< double > &value)
	Ask all component values at a specified position.

std::vector< NXString >	AskResultComponents (std::vector< NXOpen::CAE::Result::Component > &components)
	Return all results components for the current result state defined by CAE::ResultParameters.

NXOpen::CAE::ResultParameters *	GetParameters ()
	Returns the CAE::ResultParameters which defines the current result state.

NXOpen::CAE::Result *	GetResult ()
	Returns the CAE::Result which defines this result Access object The CAE::Result can be queried in order to set result state in CAE::ResultParameters.

bool	IsFullyAveraged ()
	Is result fully averaged.

std::vector< bool >	IsResultDefined (const std::vector< int > &indices)
	Returns true if a result is defined for each node or element index, If the CAE::Result::Location is Nodal then input indices are expected to be for nodes, for Elemental and ElementNodal the input indices are expected to be for elements.

void	SetParameters (NXOpen::CAE::ResultParameters *resultParameters)
	SetsCAE::ResultParameters .

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 specific result state for a given CAE::Result .

   <br/>The result state is defined by @link CAE::ResultParameters CAE::ResultParameters@endlink 
   <br/>Use @link CAE::ResultManager CAE::ResultManager@endlink  to create an @link CAE::ResultAccess CAE::ResultAccess@endlink .

   <br/>The unit of result value can be accessed using @link CAE::ResultParameters::GetUnit CAE::ResultParameters::GetUnit@endlink 
<br> An instance of this class can not be obtained  <br>

Created in NX6.0.2.

Member Function Documentation

NXOpen::CAE::Result::DataType NXOpen::CAE::ResultAccess::AskCurrentResultDataType ( )

Returns the result type for the current result state defined by CAE::ResultParameters.

Returns: Created in NX6.0.2.

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

void NXOpen::CAE::ResultAccess::AskElementNodalResult	(	int	elementIndex,
		std::vector< int > &	nodeLabels,
		std::vector< double > &	value
	)

Ask element nodal result at a specified element index
Created in NX6.0.2.

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

Parameters

elementIndex	elementindex
nodeLabels	index of nodes that forms the element
value	Values at each node

void NXOpen::CAE::ResultAccess::AskElementNodalResultAllComponents	(	int	elementIndex,
		std::vector< int > &	nodeIndex,
		int *	numComponents,
		std::vector< double > &	value
	)

Ask element nodal result at a specified element index Use CAE::ResultAccess::AskResultComponents to query type of components All values will be returned as a single dimensional array.

The array can be addressed as index = node_index*numComponents + component_index

Created in NX6.0.2.

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

Parameters

elementIndex	elementindex
nodeIndex	nodeindex
numComponents	numcomponents
value	the array size will be numComponents x totalNodes

double NXOpen::CAE::ResultAccess::AskElementResult ( int elementIndex )

Ask current component value at a specified element index.

Returns: Created in NX6.0.2.

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

Parameters

elementIndex elementindex

std::vector<double> NXOpen::CAE::ResultAccess::AskElementResult ( const std::vector< int > & elementIndices )

Ask current component value at a specified element indices.

Returns: Created in NX8.5.0.

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

Parameters

elementIndices elementindices

void NXOpen::CAE::ResultAccess::AskElementResultAllComponents	(	int	elementIndex,
		std::vector< double > &	value
	)

Ask all component values at a specified element index Use CAE::ResultAccess::AskResultComponents to query type of components
Created in NX6.0.2.

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

Parameters

elementIndex	elementindex
value	value

double NXOpen::CAE::ResultAccess::AskMaximum ( )

Ask maximum value of current result state defined by CAE::ResultParameters.

Returns: Created in NX6.0.2.

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

double NXOpen::CAE::ResultAccess::AskMinimum ( )

Ask minimum value of current result state defined by CAE::ResultParameters.

Returns: Created in NX6.0.2.

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

void NXOpen::CAE::ResultAccess::AskMinMaxLocation	(	NXOpen::CAE::Result::Location *	location,
		double *	min,
		double *	max,
		int *	minID,
		int *	maxID,
		int *	minSubID,
		int *	maxSubID
	)

Ask Min and Max value of current result state defined by CAE::ResultParameters If the CAE::Result::Location is nodal or elemental then ID will be node and element respectively.

       If it is an element-nodal result then subIDs will be node at which extreme value happens.

Created in NX6.0.2.

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

Parameters

location	location
min	min
max	max
minID	minid
maxID	maxid
minSubID	minsubid
maxSubID	maxsubid

void NXOpen::CAE::ResultAccess::AskNMinMaxLocation	(	int	numExtreme,
		NXOpen::CAE::Result::Location *	location,
		std::vector< double > &	min,
		std::vector< double > &	max,
		std::vector< int > &	minID,
		std::vector< int > &	minSubID,
		std::vector< int > &	maxID,
		std::vector< int > &	maxSubID
	)

Ask for the N extreme Min and Max values and the location of current result state defined by CAE::ResultParameters .

       @link CAE::Result::Location CAE::Result::Location@endlink  will return where the result is defined. 
       If it is an element-nodal result subIDs will be filled with node index and IDs will contain
       element index. For all other cases subIDs will be 0.

Created in NX6.0.2.

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

Parameters

numExtreme	numextreme
location	location
min	min
max	max
minID	minid
minSubID	minsubid
maxID	maxid
maxSubID	maxsubid

double NXOpen::CAE::ResultAccess::AskNodalResult ( int nodeIndex )

Ask current component value at a specified node index.

Returns: Created in NX6.0.2.

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

Parameters

nodeIndex nodeindex

std::vector<double> NXOpen::CAE::ResultAccess::AskNodalResult ( const std::vector< int > & nodeIndices )

Ask current component value at a specified node indices.

Returns: Created in NX8.5.0.

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

Parameters

nodeIndices nodeindices

void NXOpen::CAE::ResultAccess::AskNodalResultAllComponents	(	int	nodeIndex,
		std::vector< double > &	value
	)

Ask all component values at a specified node index Use CAE::ResultAccess::AskResultComponents to query type of components
Created in NX6.0.2.

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

Parameters

nodeIndex	nodeindex
value	value

double NXOpen::CAE::ResultAccess::AskResultAtLocation ( const NXOpen::Point3d & location )

Ask current component value at a specified location.

Only Nodal and Element nodal result will return valid value. If point lies outside model boundary, exception will be thrown. The result value will be interpolated at the given location

Returns: Created in NX6.0.2.

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

Parameters

location location

void NXOpen::CAE::ResultAccess::AskResultAtLocationAllComponents	(	const NXOpen::Point3d &	position,
		std::vector< double > &	value
	)

Ask all component values at a specified position.

Only Nodal and Element nodal result will return valid value. If point lies outside model boundary, exception will be thrown Use CAE::ResultAccess::AskResultComponents to query type of components. The result value will be interpolated at the given location

Created in NX6.0.2.

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

Parameters

position	position
value	value

std::vector<NXString> NXOpen::CAE::ResultAccess::AskResultComponents ( std::vector< NXOpen::CAE::Result::Component > & components )

Return all results components for the current result state defined by CAE::ResultParameters.

Returns: Created in NX6.0.2.

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

Parameters

components components

NXOpen::CAE::ResultParameters* NXOpen::CAE::ResultAccess::GetParameters ( )

Returns the CAE::ResultParameters which defines the current result state.

         <br/>The @link CAE::ResultParameters CAE::ResultParameters@endlink  can be modified but these changes will only take 
         affect after @link CAE::ResultAccess::SetParameters CAE::ResultAccess::SetParameters@endlink  is called.  @return

Created in NX6.0.2.

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

NXOpen::CAE::Result* NXOpen::CAE::ResultAccess::GetResult ( )

Returns the CAE::Result which defines this result Access object The CAE::Result can be queried in order to set result state in CAE::ResultParameters.

     @return

Created in NX6.0.2.

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

bool NXOpen::CAE::ResultAccess::IsFullyAveraged ( )

Is result fully averaged.

Returns: Created in NX6.0.2.

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

std::vector<bool> NXOpen::CAE::ResultAccess::IsResultDefined ( const std::vector< int > & indices )

Returns true if a result is defined for each node or element index, If the CAE::Result::Location is Nodal then input indices are expected to be for nodes, for Elemental and ElementNodal the input indices are expected to be for elements.

Returns: Created in NX8.5.0.

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

Parameters

indices indices

void NXOpen::CAE::ResultAccess::SetParameters ( NXOpen::CAE::ResultParameters * resultParameters )

SetsCAE::ResultParameters .

This will validate any inappropiate settings. If the input is not valid it will revert back to previous settings
Created in NX6.0.2.

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

Parameters

resultParameters result parameters

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

CAE_ResultAccess.hxx

Public Member Functions

Detailed Description

Member Function Documentation