NXOpen .NET Reference  12.0.0
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:

Public Member Functions

unsafe NXOpen.CAE.Result 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 More...
 
unsafe NXOpen.CAE.ResultParameters GetParameters ()
 Returns the NXOpen.CAE.ResultParameters which defines the current result state. More...
 
unsafe void SetParameters (NXOpen.CAE.ResultParameters resultParameters)
 SetsNXOpen.CAE.ResultParameters . More...
 
unsafe double AskMinimum ()
 Ask minimum value of current result state defined by NXOpen.CAE.ResultParameters More...
 
unsafe double AskMaximum ()
 Ask maximum value of current result state defined by NXOpen.CAE.ResultParameters More...
 
unsafe void AskNMinMaxLocation (int numExtreme, out NXOpen.CAE.Result.Location location, out double[] min, out double[] max, out int[] minID, out int[] minSubID, out int[] maxID, out int[] maxSubID)
 Ask for the N extreme Min and Max values and the location of current result state defined by NXOpen.CAE.ResultParameters . More...
 
unsafe void AskMinMaxLocation (out NXOpen.CAE.Result.Location location, out double min, out double max, out int minID, out int maxID, out int minSubID, out 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...
 
unsafe bool[] IsResultDefined (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...
 
unsafe bool[] IsResultDefined (int[] entityIndices, int[] subentityIndices)
 Returns true if a result is defined for element face/edge or element face/edge nodal result. More...
 
unsafe double AskNodalResult (int nodeIndex)
 Ask current component value at a specified node index More...
 
unsafe double[] AskNodalResult (int[] nodeIndices)
 Ask current component value at a specified node indices More...
 
unsafe void AskNodalResultAllComponents (int nodeIndex, out double[] value)
 Ask all component values at a specified node index Use NXOpen.CAE.ResultAccess.AskResultComponents to query type of components More...
 
unsafe double AskElementResult (int elementIndex)
 Ask current component value at a specified element index. More...
 
unsafe double[] AskElementResult (int[] elementIndices)
 Ask current component value at a specified element indices. More...
 
unsafe void AskElementResultAllComponents (int elementIndex, out double[] value)
 Ask all component values at a specified element index Use NXOpen.CAE.ResultAccess.AskResultComponents to query type of components More...
 
unsafe void AskElementNodalResult (int elementIndex, out int[] nodeLabels, out double[] value)
 Ask element nodal result at a specified element index More...
 
unsafe void AskElementNodalResultAllComponents (int elementIndex, out int[] nodeIndex, out int numComponents, out 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...
 
unsafe double AskResultAtLocation (NXOpen.Point3d location)
 Ask current component value at a specified location. More...
 
unsafe void AskResultAtLocationAllComponents (NXOpen.Point3d position, out double[] value)
 Ask all component values at a specified position. More...
 
unsafe NXOpen.CAE.Result.DataType AskCurrentResultDataType ()
 Returns the result type for the current result state defined by NXOpen.CAE.ResultParameters More...
 
unsafe string[] AskResultComponents (out NXOpen.CAE.Result.Component[] components)
 Return all results components for the current result state defined by NXOpen.CAE.ResultParameters More...
 
unsafe bool IsFullyAveraged ()
 Is result fully averaged More...
 
unsafe double AskElementFaceResult (int elementIndex, int faceIndex)
 Ask current component value at a specified element and face index. More...
 
unsafe double AskElementEdgeResult (int elementIndex, int edgeIndex)
 Ask current component value at a specified element and edge index. More...
 
unsafe double AskElementFaceNodalResult (int elementIndex, int faceIndex, int nodeIndex)
 Ask current component value at a specified element, face and node index. More...
 
unsafe double AskElementEdgeNodalResult (int elementIndex, int edgeIndex, int nodeIndex)
 Ask current component value at a specified element, edge and node index. More...
 
unsafe void AskElementFaceResultAllComponents (int elementIndex, int faceIndex, out double[] value)
 Ask all component values at a specified element index, face index. More...
 
unsafe void AskElementEdgeResultAllComponents (int elementIndex, int edgeIndex, out double[] value)
 Ask all component values at a specified element index, edge index. More...
 
unsafe void AskElementFaceNodalResultAllComponents (int elementIndex, int faceIndex, int nodeIndex, out double[] value)
 Ask all component values at a specified element index, face index, node index. More...
 
unsafe void AskElementEdgeNodalResultAllComponents (int elementIndex, int edgeIndex, int nodeIndex, out double[] value)
 Ask all component values at a specified element index, edge index, node index. More...
 
unsafe double AskElementNodalResult (int elementIndex, int nodeIndex)
 Ask current component value at a specified element index and node index More...
 
unsafe void AskElementNodalResultAllComponents (int elementIndex, int nodeIndex, out double[] value)
 Ask element nodal result at a specified element index, node index Use NXOpen.CAE.ResultAccess.AskElementNodalResultAllComponents to query all type of components More...
 
unsafe NXOpen.CAE.Result.Location AskResultLocation ()
 Ask result location current result state. 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

unsafe NXOpen.CAE.Result.DataType NXOpen.CAE.ResultAccess.AskCurrentResultDataType ( )

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

Created in NX6.0.2

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

Returns
unsafe double NXOpen.CAE.ResultAccess.AskElementEdgeNodalResult ( int  elementIndex,
int  edgeIndex,
int  nodeIndex 
)

Ask current component value at a specified element, edge and node index.

Edge index will vary from 0 to n-1 where, n is the number of edges on element

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
edgeIndexedge index ranges from 0 to N-1 (where N is number of edges) NXOpen.CAE.Result.AskNumEdgesOnElement
nodeIndexnode index ranges from 1 to N (number of nodes) NXOpen.CAE.Result.AskNumNodes
Returns
unsafe void NXOpen.CAE.ResultAccess.AskElementEdgeNodalResultAllComponents ( int  elementIndex,
int  edgeIndex,
int  nodeIndex,
out double[]  value 
)

Ask all component values at a specified element index, edge index, node index.

Edge index will vary from 0 to n-1 where, n is the number of edges on element. Use NXOpen.CAE.ResultAccess.AskElementEdgeNodalResultAllComponents to query all components

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
edgeIndexedge index ranges from 0 to N-1 (whre N is number of edges) NXOpen.CAE.Result.AskNumEdgesOnElement
nodeIndexnode index ranges from 1 to N (number of nodes) NXOpen.CAE.Result.AskNumNodes
value
unsafe double NXOpen.CAE.ResultAccess.AskElementEdgeResult ( int  elementIndex,
int  edgeIndex 
)

Ask current component value at a specified element and edge index.

Edge index will vary from 0 to n-1 where, n is the number of edges on element.

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
edgeIndexedge index ranges from 0 to N-1 (where N is number of edges) NXOpen.CAE.Result.AskNumEdgesOnElement
Returns
unsafe void NXOpen.CAE.ResultAccess.AskElementEdgeResultAllComponents ( int  elementIndex,
int  edgeIndex,
out double[]  value 
)

Ask all component values at a specified element index, edge index.

Edge index will vary from 0 to n-1 where, n is the number of edges on element. Use NXOpen.CAE.ResultAccess.AskElementFaceResultAllComponents to query all components

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
edgeIndexedge index ranges from 0 to N-1 (where N is number of edges) NXOpen.CAE.Result.AskNumEdgesOnElement
value
unsafe double NXOpen.CAE.ResultAccess.AskElementFaceNodalResult ( int  elementIndex,
int  faceIndex,
int  nodeIndex 
)

Ask current component value at a specified element, face and node index.

Face index will vary from 0 to n-1 where, n is the number of faces on element.

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
faceIndexface index ranges from 0 to N-1 (where N is number of faces) NXOpen.CAE.Result.AskNumFacesOnElement
nodeIndexnode index ranges from 1 to N (number of nodes) NXOpen.CAE.Result.AskNumNodes
Returns
unsafe void NXOpen.CAE.ResultAccess.AskElementFaceNodalResultAllComponents ( int  elementIndex,
int  faceIndex,
int  nodeIndex,
out double[]  value 
)

Ask all component values at a specified element index, face index, node index.

Face index will vary from 0 to n-1 where, n is the number of faces on element. Use NXOpen.CAE.ResultAccess.AskElementFaceNodalResultAllComponents to all components

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
faceIndexface index ranges from 0 to N-1 (whre N is number of faces) NXOpen.CAE.Result.AskNumFacesOnElement
nodeIndexnode index ranges from 1 to N (number of nodes) NXOpen.CAE.Result.AskNumNodes
value
unsafe double NXOpen.CAE.ResultAccess.AskElementFaceResult ( int  elementIndex,
int  faceIndex 
)

Ask current component value at a specified element and face index.

Face index will vary from 0 to n-1 where, n is the number of faces on element.

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
faceIndexface index ranges from 0 to N-1 (where N is number of faces) NXOpen.CAE.Result.AskNumFacesOnElement
Returns
unsafe void NXOpen.CAE.ResultAccess.AskElementFaceResultAllComponents ( int  elementIndex,
int  faceIndex,
out double[]  value 
)

Ask all component values at a specified element index, face index.

Face index will vary from 0 to n-1 where, n is the number of faces on element. Use NXOpen.CAE.ResultAccess.AskElementFaceResultAllComponents to query all components

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
faceIndexface index ranges from 0 to N-1 (where N is number of faces) NXOpen.CAE.Result.AskNumFacesOnElement
value
unsafe void NXOpen.CAE.ResultAccess.AskElementNodalResult ( int  elementIndex,
out int[]  nodeLabels,
out 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
nodeLabelsindex of nodes that forms the element
valueValues at each node
unsafe double NXOpen.CAE.ResultAccess.AskElementNodalResult ( int  elementIndex,
int  nodeIndex 
)

Ask current component value at a specified element index and node index

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
nodeIndexnode index ranges from 1 to N (number of nodes) NXOpen.CAE.Result.AskNumNodes
Returns
unsafe void NXOpen.CAE.ResultAccess.AskElementNodalResultAllComponents ( int  elementIndex,
out int[]  nodeIndex,
out int  numComponents,
out 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
elementIndex
nodeIndex
numComponents
valuethe array size will be numComponents x totalNodes
unsafe void NXOpen.CAE.ResultAccess.AskElementNodalResultAllComponents ( int  elementIndex,
int  nodeIndex,
out double[]  value 
)

Ask element nodal result at a specified element index, node index Use NXOpen.CAE.ResultAccess.AskElementNodalResultAllComponents to query all type of components

Created in NX11.0.0

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

Parameters
elementIndexelement index ranges from 1 to N (where N is number of elements) NXOpen.CAE.Result.AskNumElements
nodeIndexnode index ranges from 1 to N (number of nodes) NXOpen.CAE.Result.AskNumNodes
value
unsafe double NXOpen.CAE.ResultAccess.AskElementResult ( int  elementIndex)

Ask current component value 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
Returns
unsafe double [] NXOpen.CAE.ResultAccess.AskElementResult ( int[]  elementIndices)

Ask current component value at a specified element indices.

Created in NX8.5.0

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

Parameters
elementIndices
Returns
unsafe void NXOpen.CAE.ResultAccess.AskElementResultAllComponents ( int  elementIndex,
out 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
elementIndex
value
unsafe double NXOpen.CAE.ResultAccess.AskMaximum ( )

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

Created in NX6.0.2

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

Returns
unsafe double NXOpen.CAE.ResultAccess.AskMinimum ( )

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

Created in NX6.0.2

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

Returns
unsafe void NXOpen.CAE.ResultAccess.AskMinMaxLocation ( out NXOpen.CAE.Result.Location  location,
out double  min,
out double  max,
out int  minID,
out int  maxID,
out int  minSubID,
out 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
location
min
max
minID
maxID
minSubID
maxSubID
unsafe void NXOpen.CAE.ResultAccess.AskNMinMaxLocation ( int  numExtreme,
out NXOpen.CAE.Result.Location  location,
out double[]  min,
out double[]  max,
out int[]  minID,
out int[]  minSubID,
out int[]  maxID,
out 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
numExtreme
location
min
max
minID
minSubID
maxID
maxSubID
unsafe double NXOpen.CAE.ResultAccess.AskNodalResult ( int  nodeIndex)

Ask current component value at a specified node index

Created in NX6.0.2

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

Parameters
nodeIndex
Returns
unsafe double [] NXOpen.CAE.ResultAccess.AskNodalResult ( int[]  nodeIndices)

Ask current component value at a specified node indices

Created in NX8.5.0

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

Parameters
nodeIndices
Returns
unsafe void NXOpen.CAE.ResultAccess.AskNodalResultAllComponents ( int  nodeIndex,
out 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
nodeIndex
value
unsafe double NXOpen.CAE.ResultAccess.AskResultAtLocation ( 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

Created in NX6.0.2

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

Parameters
location
Returns
unsafe void NXOpen.CAE.ResultAccess.AskResultAtLocationAllComponents ( NXOpen.Point3d  position,
out 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
position
value
unsafe string [] NXOpen.CAE.ResultAccess.AskResultComponents ( out NXOpen.CAE.Result.Component[]  components)

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

Created in NX6.0.2

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

Parameters
components
Returns
unsafe NXOpen.CAE.Result.Location NXOpen.CAE.ResultAccess.AskResultLocation ( )

Ask result location current result state.

NXOpen.CAE.Result.Location will be returned.

Created in NX11.0.0

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

Returns
unsafe 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.

Created in NX6.0.2

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

Returns
unsafe 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

Created in NX6.0.2

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

Returns
unsafe bool NXOpen.CAE.ResultAccess.IsFullyAveraged ( )

Is result fully averaged

Created in NX6.0.2

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

Returns
unsafe bool [] NXOpen.CAE.ResultAccess.IsResultDefined ( 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

Created in NX8.5.0

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

Parameters
indices
Returns
unsafe bool [] NXOpen.CAE.ResultAccess.IsResultDefined ( int[]  entityIndices,
int[]  subentityIndices 
)

Returns true if a result is defined for element face/edge or element face/edge nodal result.

For Element Face/Edge results entityIndices should be element index and subentityIndices should be face/edge indices. Proper mapping should be maintained in entityIndices and subentityIndices.

Created in NX11.0.0

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

Parameters
entityIndiceselement/node index will vary from 1 to N (where N is number of elements/nodes)
subentityIndicesFace/edge index will vary from 0 to n-1 where, n is the number of faces/edges on element.
Returns
unsafe 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
resultParameters

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