ResultAccess Class¶
-
class
NXOpen.CAE.
ResultAccess
¶ Bases:
NXOpen.TaggedObject
Represents a specific result state for a given
NXOpen.CAE.Result
.<br/>The result state is defined by
NXOpen.CAE.ResultParameters
<br/>UseNXOpen.CAE.ResultManager
to create anNXOpen.CAE.ResultAccess
.<br/>The unit of result value can be accessed using
NXOpen.CAE.ResultParameters.GetUnit
An instance of this class can not be obtained
New in version NX6.0.2.
Methods¶
Method | Description |
---|---|
AskCurrentResultDataType | Returns the result type for the current result state defined by NXOpen.CAE.ResultParameters @return |
AskElementNodalResult | Ask element nodal result at a specified element index |
AskElementNodalResultAllComponents | 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. |
AskElementResult | Ask current component value at a specified element index. |
AskElementResultAllComponents | Ask all component values at a specified element index Use NXOpen.CAE.ResultAccess.AskResultComponents to query type of components |
AskMaximum | Ask maximum value of current result state defined by NXOpen.CAE.ResultParameters @return |
AskMinMaxLocation | Ask Min and Max value of current result state defined by NXOpen.CAE.ResultParameters If the NXOpen.CAE.ResultLocation is nodal or elemental then ID will be node and element respectively. |
AskMinimum | Ask minimum value of current result state defined by NXOpen.CAE.ResultParameters @return |
AskNMinMaxLocation | Ask for the N extreme Min and Max values and the location of current result state defined by NXOpen.CAE.ResultParameters . |
AskNodalResult | Ask current component value at a specified node index @return |
AskNodalResultAllComponents | Ask all component values at a specified node index Use NXOpen.CAE.ResultAccess.AskResultComponents to query type of components |
AskResultAtLocation | Ask current component value at a specified location. |
AskResultAtLocationAllComponents | Ask all component values at a specified position. |
AskResultComponents | Return all results components for the current result state defined by NXOpen.CAE.ResultParameters @return |
GetParameters | Returns the NXOpen.CAE.ResultParameters which defines the current result state. |
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 @return |
IsFullyAveraged | Is result fully averaged @return |
IsResultDefined | Returns true if a result is defined for each node or element index, If the NXOpen.CAE.ResultLocation is Nodal then input indices are expected to be for nodes, for Elemental and ElementNodal the input indices are expected to be for elements @return |
SetParameters | Sets:py:class:NXOpen.CAE.ResultParameters. |
Method Detail¶
AskCurrentResultDataType¶
-
ResultAccess.
AskCurrentResultDataType
¶ Returns the result type for the current result state defined by
NXOpen.CAE.ResultParameters
Signature
AskCurrentResultDataType()
Returns: Return type: NXOpen.CAE.ResultDataType
New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskElementNodalResult¶
-
ResultAccess.
AskElementNodalResult
¶ Ask element nodal result at a specified element index
Signature
AskElementNodalResult(elementIndex)
Parameters: elementIndex (int) – Returns: a tuple Return type: A tuple consisting of (nodeLabels, value). nodeLabels is a list of int. index of nodes that forms the element value is a list of float. Values at each node New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskElementNodalResultAllComponents¶
-
ResultAccess.
AskElementNodalResultAllComponents
¶ 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
Signature
AskElementNodalResultAllComponents(elementIndex)
Parameters: elementIndex (int) – Returns: a tuple Return type: A tuple consisting of (nodeIndex, numComponents, value). nodeIndex is a list of int. numComponents is a int. value is a list of float. the array size will be numComponents x totalNodes New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskElementResult¶
-
ResultAccess.
AskElementResult
¶ Overloaded method AskElementResult
AskElementResult(elementIndex)
AskElementResult(elementIndices)
-------------------------------------
Ask current component value at a specified element index.
Signature
AskElementResult(elementIndex)
Parameters: elementIndex (int) – Returns: Return type: float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Ask current component value at a specified element indices.
Signature
AskElementResult(elementIndices)
Parameters: elementIndices (list of int) – Returns: Return type: list of float New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
AskElementResultAllComponents¶
-
ResultAccess.
AskElementResultAllComponents
¶ Ask all component values at a specified element index Use
NXOpen.CAE.ResultAccess.AskResultComponents
to query type of componentsSignature
AskElementResultAllComponents(elementIndex)
Parameters: elementIndex (int) – Returns: Return type: list of float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskMaximum¶
-
ResultAccess.
AskMaximum
¶ Ask maximum value of current result state defined by
NXOpen.CAE.ResultParameters
Signature
AskMaximum()
Returns: Return type: float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskMinMaxLocation¶
-
ResultAccess.
AskMinMaxLocation
¶ Ask Min and Max value of current result state defined by
NXOpen.CAE.ResultParameters
If theNXOpen.CAE.ResultLocation
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.
Signature
AskMinMaxLocation()
Returns: a tuple Return type: A tuple consisting of (location, min, max, minID, maxID, minSubID, maxSubID). location is a NXOpen.CAE.ResultLocation
. min is a float. max is a float. minID is a int. maxID is a int. minSubID is a int. maxSubID is a int.New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskMinimum¶
-
ResultAccess.
AskMinimum
¶ Ask minimum value of current result state defined by
NXOpen.CAE.ResultParameters
Signature
AskMinimum()
Returns: Return type: float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskNMinMaxLocation¶
-
ResultAccess.
AskNMinMaxLocation
¶ Ask for the N extreme Min and Max values and the location of current result state defined by
NXOpen.CAE.ResultParameters
.NXOpen.CAE.ResultLocation
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.Signature
AskNMinMaxLocation(numExtreme)
Parameters: numExtreme (int) – Returns: a tuple Return type: A tuple consisting of (location, min, max, minID, minSubID, maxID, maxSubID). location is a NXOpen.CAE.ResultLocation
. min is a list of float. max is a list of float. minID is a list of int. minSubID is a list of int. maxID is a list of int. maxSubID is a list of int.New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskNodalResult¶
-
ResultAccess.
AskNodalResult
¶ Overloaded method AskNodalResult
AskNodalResult(nodeIndex)
AskNodalResult(nodeIndices)
-------------------------------------
Ask current component value at a specified node index
Signature
AskNodalResult(nodeIndex)
Parameters: nodeIndex (int) – Returns: Return type: float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Ask current component value at a specified node indices
Signature
AskNodalResult(nodeIndices)
Parameters: nodeIndices (list of int) – Returns: Return type: list of float New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
AskNodalResultAllComponents¶
-
ResultAccess.
AskNodalResultAllComponents
¶ Ask all component values at a specified node index Use
NXOpen.CAE.ResultAccess.AskResultComponents
to query type of componentsSignature
AskNodalResultAllComponents(nodeIndex)
Parameters: nodeIndex (int) – Returns: Return type: list of float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskResultAtLocation¶
-
ResultAccess.
AskResultAtLocation
¶ 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
Signature
AskResultAtLocation(location)
Parameters: location ( NXOpen.Point3d
) –Returns: Return type: float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskResultAtLocationAllComponents¶
-
ResultAccess.
AskResultAtLocationAllComponents
¶ 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 locationSignature
AskResultAtLocationAllComponents(position)
Parameters: position ( NXOpen.Point3d
) –Returns: Return type: list of float New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
AskResultComponents¶
-
ResultAccess.
AskResultComponents
¶ Return all results components for the current result state defined by
NXOpen.CAE.ResultParameters
Signature
AskResultComponents()
Returns: a tuple Return type: A tuple consisting of (description, components). description is a list of str. components is a list of
NXOpen.CAE.ResultComponent
. .. versionadded:: NX6.0.2License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GetParameters¶
-
ResultAccess.
GetParameters
¶ Returns the
NXOpen.CAE.ResultParameters
which defines the current result state.<br/>The
NXOpen.CAE.ResultParameters
can be modified but these changes will only take affect afterNXOpen.CAE.ResultAccess.SetParameters
is called.Signature
GetParameters()
Returns: Return type: NXOpen.CAE.ResultParameters
New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GetResult¶
-
ResultAccess.
GetResult
¶ Returns the
NXOpen.CAE.Result
which defines this result Access object TheNXOpen.CAE.Result
can be queried in order to set result state inNXOpen.CAE.ResultParameters
Signature
GetResult()
Returns: Return type: NXOpen.CAE.Result
New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IsFullyAveraged¶
-
ResultAccess.
IsFullyAveraged
¶ Is result fully averaged
Signature
IsFullyAveraged()
Returns: Return type: bool New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
IsResultDefined¶
-
ResultAccess.
IsResultDefined
¶ Returns true if a result is defined for each node or element index, If the
NXOpen.CAE.ResultLocation
is Nodal then input indices are expected to be for nodes, for Elemental and ElementNodal the input indices are expected to be for elementsSignature
IsResultDefined(indices)
Parameters: indices (list of int) – Returns: Return type: list of bool New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetParameters¶
-
ResultAccess.
SetParameters
¶ Sets:py:class:NXOpen.CAE.ResultParameters.
This will validate any inappropiate settings. If the input is not valid it will revert back to previous settings
Signature
SetParameters(resultParameters)
Parameters: resultParameters ( NXOpen.CAE.ResultParameters
) –New in version NX6.0.2.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)