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

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

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

Public Member Functions

NXOpen::CAE::Result::DataType AskCurrentResultDataType ()
 Returns the result type for the current result state defined by NXOpen::CAE::ResultParameters. More...
 
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. More...
 
void AskElementNodalResultAllComponents (int elementIndex, std::vector< int > &nodeIndex, int *numComponents, std::vector< double > &value)
 Ask element nodal result at a specified element index Use NXOpen::CAE::ResultAccess::AskResultComponents to query type of components All values will be returned as a single dimensional array. More...
 
double AskElementResult (int elementIndex)
 Ask current component value at a specified element index. More...
 
std::vector< double > AskElementResult (const std::vector< int > &elementIndices)
 Ask current component value at a specified element indices. More...
 
void AskElementResultAllComponents (int elementIndex, std::vector< double > &value)
 Ask all component values at a specified element index Use NXOpen::CAE::ResultAccess::AskResultComponents to query type of components
Created in NX6.0.2. More...
 
double AskMaximum ()
 Ask maximum value of current result state defined by NXOpen::CAE::ResultParameters. More...
 
double AskMinimum ()
 Ask minimum value of current result state defined by NXOpen::CAE::ResultParameters. More...
 
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 NXOpen::CAE::ResultParameters If the NXOpen::CAE::Result::Location is nodal or elemental then ID will be node and element respectively. More...
 
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 NXOpen::CAE::ResultParameters . More...
 
double AskNodalResult (int nodeIndex)
 Ask current component value at a specified node index. More...
 
std::vector< double > AskNodalResult (const std::vector< int > &nodeIndices)
 Ask current component value at a specified node indices. More...
 
void AskNodalResultAllComponents (int nodeIndex, std::vector< double > &value)
 Ask all component values at a specified node index Use NXOpen::CAE::ResultAccess::AskResultComponents to query type of components
Created in NX6.0.2. More...
 
double AskResultAtLocation (const NXOpen::Point3d &location)
 Ask current component value at a specified location. More...
 
void AskResultAtLocationAllComponents (const NXOpen::Point3d &position, std::vector< double > &value)
 Ask all component values at a specified position. More...
 
std::vector< NXStringAskResultComponents (std::vector< NXOpen::CAE::Result::Component > &components)
 Return all results components for the current result state defined by NXOpen::CAE::ResultParameters. More...
 
NXOpen::CAE::ResultParametersGetParameters ()
 Returns the NXOpen::CAE::ResultParameters which defines the current result state. More...
 
NXOpen::CAE::ResultGetResult ()
 Returns the NXOpen::CAE::Result which defines this result Access object The NXOpen::CAE::Result can be queried in order to set result state in NXOpen::CAE::ResultParameters. More...
 
bool IsFullyAveraged ()
 Is result fully averaged. More...
 
std::vector< bool > IsResultDefined (const std::vector< int > &indices)
 Returns true if a result is defined for each node or element index, If the NXOpen::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. More...
 
void SetParameters (NXOpen::CAE::ResultParameters *resultParameters)
 SetsNXOpen::CAE::ResultParameters . More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


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


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

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 NXOpen::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 NXOpen::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
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
elementIndiceselementindices
void NXOpen::CAE::ResultAccess::AskElementResultAllComponents ( int  elementIndex,
std::vector< double > &  value 
)

Ask all component values at a specified element index Use NXOpen::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
double NXOpen::CAE::ResultAccess::AskMaximum ( )

Ask maximum value of current result state defined by NXOpen::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 NXOpen::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 NXOpen::CAE::ResultParameters If the NXOpen::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 NXOpen::CAE::ResultParameters .

NXOpen::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
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
nodeIndicesnodeindices
void NXOpen::CAE::ResultAccess::AskNodalResultAllComponents ( int  nodeIndex,
std::vector< double > &  value 
)

Ask all component values at a specified node index Use NXOpen::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
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
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 NXOpen::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
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 NXOpen::CAE::ResultParameters.

Returns

Created in NX6.0.2.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")
Parameters
componentscomponents
NXOpen::CAE::ResultParameters* NXOpen::CAE::ResultAccess::GetParameters ( )

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


The NXOpen::CAE::ResultParameters can be modified but these changes will only take affect after NXOpen::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")
NXOpen::CAE::Result* NXOpen::CAE::ResultAccess::GetResult ( )

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

Returns

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 NXOpen::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
indicesindices
void NXOpen::CAE::ResultAccess::SetParameters ( NXOpen::CAE::ResultParameters resultParameters)

SetsNXOpen::CAE::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 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.