NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAE::ResultAccess Class Reference

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

Inheritance diagram for NXOpen::CAE::ResultAccess:
NXOpen::TaggedObject

List of all members.

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.
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.
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< NXStringAskResultComponents (std::vector< NXOpen::CAE::Result::Component > &components)
 Return all results components for the current result state defined by CAE::ResultParameters.
NXOpen::CAE::ResultParametersGetParameters ()
 Returns the CAE::ResultParameters which defines the current result state.
NXOpen::CAE::ResultGetResult ()
 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.
void SetParameters (NXOpen::CAE::ResultParameters *resultParameters)
 SetsCAE::ResultParameters .

Detailed Description

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


The result state is defined by CAE::ResultParameters
Use CAE::ResultManager to create an CAE::ResultAccess .


The unit of result value can be accessed using CAE::ResultParameters::GetUnit
An instance of this class can not be obtained

Created in NX6.0.2.


Member Function Documentation

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:
elementIndexelementindex
nodeLabelsindex of nodes that forms the element
valueValues 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:
elementIndexelementindex
nodeIndexnodeindex
numComponentsnumcomponents
valuethe 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:
elementIndexelementindex
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:
elementIndexelementindex
valuevalue

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")

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:
locationlocation
minmin
maxmax
minIDminid
maxIDmaxid
minSubIDminsubid
maxSubIDmaxsubid
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 .

CAE::Result::Location 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:
numExtremenumextreme
locationlocation
minmin
maxmax
minIDminid
minSubIDminsubid
maxIDmaxid
maxSubIDmaxsubid
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:
nodeIndexnodeindex
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:
nodeIndexnodeindex
valuevalue

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:
locationlocation
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:
positionposition
valuevalue

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:
componentscomponents

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


The CAE::ResultParameters can be modified but these changes will only take affect after CAE::ResultAccess::SetParameters is called.

Returns:

Created in NX6.0.2.

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

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.

Returns:

Created in NX6.0.2.

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

Is result fully averaged.

Returns:

Created in NX6.0.2.

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

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:
resultParametersresult parameters

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