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

This class is worked as a packet of information that can be either be used to change result state or pass around for information exchange between two CAE::ResultAccess objects. More...

Inheritance diagram for NXOpen::CAE::ResultParameters:
NXOpen::TaggedObject

List of all members.

Public Member Functions

int AskSectionPlyLayer (int *section, int *ply)
 Ask section, ply and layer.
void DisplayMidnodeValue (bool display)
 This is display only command.
bool GetAbsoluteValue ()
 Ask whether all values are absolute values.
NXOpen::CAE::Result::Averaging GetAveragingCriteria ()
 Ask averaging criteria.
double GetBeamFilletRadius ()
 Return the fillet radius.
bool GetBeamFillets ()
 Return the fillets flag.
bool GetBeamResultsInLocalCoordinateSystem ()
 Identifies whether beam results are presented in local coordinate system (if true) or in the same coordinate system as the rest of the model.
bool GetCalculateBeamStrResults ()
 Ask if beam stresses and strains are calculated from element forces and section geometry.
NXOpen::CAE::Result::Complex GetComplexCriterion ()
 If result is complex it returns which component is set(like real or imaginary)
NXOpen::CAE::Result::ComputationType GetComputationType ()
 Get computing type.
NXOpen::CAE::Result::CoordinateSystem GetCoordinateSystem ()
 Ask result coordinate system.
NXOpen::CAE::Result::ElementValueCriterion GetElementValueCriterion ()
 Ask how element the result is defined.
bool GetExcludeElementsNotVisible ()
 Ask whether elements which are not visible are consider for summation.
NXOpen::CAE::BaseResultTypeGetGenericResultType ()
 Ask Result type.
int GetIteration ()
 Ask Current iteration number This method has been deprecated.
int GetLoadcase ()
 Ask Current loadcase number This method has been deprecated.
double GetPhaseAngle ()
 Ask phase angle.
NXOpen::CAE::Result::Section GetResultBeamSection ()
 Ask section where beam results are defined.
NXOpen::CAE::Result::Component GetResultComponent ()
 Ask result component.
NXOpen::CAE::Result::Location GetResultDataLocation ()
 Ask FE entity where the result is defined This method has been deprecated.
NXOpen::CAE::Result::Quantity GetResultDataQuantity ()
 Ask result type This method has been deprecated.
NXOpen::CAE::Result::Section GetResultDataSection ()
 Ask section of a FE entity where the result is defined This method has been deprecated.
NXOpen::CAE::Result::Section GetResultShellSection ()
 Ask section where shell results are defined.
NXOpen::CAE::Result::Type GetResultType ()
 Ask Result type This method has been deprecated.
double GetScale ()
 Ask scale.
void GetSelectedCoordinateSystem (NXOpen::CAE::Result::CoordinateSystemSource *source, int *id)
 Ask selected coordinate system in which results are to be presented
Created in NX7.5.1.
NXOpen::CAE::Result::TensorDerivedAbsolute GetTensorComponentAbsoluteValue ()
 Get the method used when calculating the absolute values for the derived components of CAE::Result::DataTypeTensor like CAE::Result::ComponentMaximumPrincipal.
NXOpen::UnitGetUnit ()
 Ask result unit.
NXOpen::CAE::Result::Averaging InitAveragingCriteria ()
 Ask default averaging criteria.
bool IsForcedElementResult ()
 Ask whether the result is converted as element result.
bool IsMidnodeValueDisplayed ()
 Ask whether the result at mid nodes are ignored.
void MakeElementResult (bool elementResult)
 Make Nodal and Element-Nodal result to Element Result.
void SetAbsoluteValue (bool absolute)
 Set all values to absolute values.
void SetAveragingCriteria (const NXOpen::CAE::Result::Averaging &average)
 Set averaging criteria
Created in NX6.0.2.
void SetBeamFilletRadius (double beamFilletRadius)
 Sets the fillet radius as a fraction of the adjacent dimensions
Created in NX7.5.0.
void SetBeamFillets (bool beamFillets)
 Sets the fillets flag
Created in NX7.5.0.
void SetBeamResultsInLocalCoordinateSystem (bool local)
 Presents beam results in local coordinate system (if flag is true) or in the same coordinate system as the rest of the model
Created in NX7.5.0.
void SetCalculateBeamStrResults (bool calcBeamStrResults)
 Sets a flag to calculate beam stresses and strains from element forces and section geometry (if available).
void SetComplexCriterion (NXOpen::CAE::Result::Complex complex)
 Set complex criteria
Created in NX6.0.2.
void SetComputationType (NXOpen::CAE::Result::ComputationType computeType)
 Set computing type.
void SetCoordinateSystem (NXOpen::CAE::Result::CoordinateSystem coordinate)
 Set result coordinate system
Created in NX6.0.2.
void SetElementValueCriterion (NXOpen::CAE::Result::ElementValueCriterion criteria)
 Set how element the result is defined This option is only valid for nodal and elemen-nodal result; dose not do anything for element result.
void SetExcludeElementsNotVisible (bool excludeElements)
 Exclude or include elements which are not visible for computing with sum option.
void SetGenericResultType (NXOpen::CAE::BaseResultType *type)
 Set Result type
Created in NX7.5.0.
void SetLoadcaseIteration (int loadcase, int iteration)
 Set Current loadcase and iteration.
void SetPhaseAngle (double angle)
 Sets the phase angle at which result will be evaluated.
void SetResultBeamSection (NXOpen::CAE::Result::Section section)
 Set section where beam results are defined
Created in NX7.5.0.
void SetResultComponent (NXOpen::CAE::Result::Component component)
 Set result component
Created in NX6.0.2.
void SetResultDataLocation (NXOpen::CAE::Result::Location location)
 Set FE entity where the result is defined This method has been deprecated.
void SetResultDataQuantity (NXOpen::CAE::Result::Quantity quantity)
 Set result quantity This method has been deprecated.
void SetResultDataSection (NXOpen::CAE::Result::Section section)
 Set section of a FE entity where the result is defined This method has been deprecated.
void SetResultShellSection (NXOpen::CAE::Result::Section section)
 Set section where shell results are defined
Created in NX7.5.0.
void SetResultType (const NXOpen::CAE::Result::Type &type)
 Set Result type This method has been deprecated.
void SetScale (double scale)
 Set scale.
void SetSectionPlyLayer (int section, int ply, int layer)
 Set section, ply and layer
Created in NX6.0.2.
void SetSelectedCoordinateSystem (NXOpen::CAE::Result::CoordinateSystemSource source, int id)
 Set selected coordinate system in which results are to be presented Coordinate systems labels defined in a result file can be retrieved using CAE::Result::GetResultCoordinateSystems.
void SetTensorComponentAbsoluteValue (NXOpen::CAE::Result::TensorDerivedAbsolute absolute)
 Set the method used when calculating the absolute values for the derived components of CAE::Result::DataTypeTensor like CAE::Result::ComponentMaximumPrincipal.
void SetUnit (NXOpen::Unit *unit)
 Set result unit
Created in NX6.0.2.

Detailed Description

This class is worked as a packet of information that can be either be used to change result state or pass around for information exchange between two CAE::ResultAccess objects.


Use CAE::ResultManager to create an CAE::ResultParameters


You can modifiy these values but validation of correctness will only be perfomed when this object is set to a CAE::ResultAccess object
To obtain an instance of this class use Session::ResultManager .

Created in NX6.0.2.


Member Function Documentation

int NXOpen::CAE::ResultParameters::AskSectionPlyLayer ( int *  section,
int *  ply 
)

Ask section, ply and layer.

Returns:

Created in NX6.0.2.

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

This is display only command.

Setting this value will not change modify ResultAccess queries. But Post view will ignore midnode values during display


Created in NX6.0.2.

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

Parameters:
displaydisplay

Ask whether all values are absolute values.

Returns:

Created in NX6.0.2.

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

Ask averaging criteria.

Returns:

Created in NX6.0.2.

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

Return the fillet radius.

Returns:

Created in NX7.5.0.

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

Return the fillets flag.

Returns:

Created in NX7.5.0.

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

Identifies whether beam results are presented in local coordinate system (if true) or in the same coordinate system as the rest of the model.

Returns:

Created in NX7.5.0.

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

Ask if beam stresses and strains are calculated from element forces and section geometry.

Returns:

Created in NX7.5.0.

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

If result is complex it returns which component is set(like real or imaginary)

Returns:

Created in NX6.0.2.

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

Get computing type.

Returns:

Created in NX7.5.1.

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

Ask result coordinate system.

Returns:

Created in NX6.0.2.

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

Ask how element the result is defined.

This option is only valid for nodal and elemen-nodal result.

Returns:

Created in NX6.0.2.

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

Ask whether elements which are not visible are consider for summation.

Returns:

Created in NX7.5.1.

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

Ask Result type.

Returns:

Created in NX7.5.0.

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

Ask Current iteration number This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Ask Current loadcase number This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Ask phase angle.

If complex result is set to Phaseangle type then user can specify an angle at which result will be evaluated

Returns:

Created in NX6.0.2.

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

Ask section where beam results are defined.

Returns:

Created in NX7.5.0.

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

Ask result component.

Returns:

Created in NX6.0.2.

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

Ask FE entity where the result is defined This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Ask result type This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Ask section of a FE entity where the result is defined This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Ask section where shell results are defined.

Returns:

Created in NX7.5.0.

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

Ask Result type This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .

Returns:

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Ask scale.

Returns:

Created in NX6.0.2.

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

Ask selected coordinate system in which results are to be presented
Created in NX7.5.1.



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

Parameters:
sourcesource
idid

Get the method used when calculating the absolute values for the derived components of CAE::Result::DataTypeTensor like CAE::Result::ComponentMaximumPrincipal.

Returns:

Created in NX8.0.1.

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

Ask result unit.

Returns:

Created in NX6.0.2.

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

Ask default averaging criteria.

Returns:

Created in NX6.0.2.

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

Ask whether the result is converted as element result.

Returns:

Created in NX7.5.0.

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

Ask whether the result at mid nodes are ignored.

Returns:

Created in NX7.5.0.

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

Make Nodal and Element-Nodal result to Element Result.

Does not do anything if the result is element result already. To define what value should be used to represent an element, use CAE::ResultParameters::SetElementValueCriterion


Created in NX6.0.2.

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

Parameters:
elementResultelementresult

Set all values to absolute values.

Warning: Once converted to absolute value it is not possible to revert to original values.


Created in NX6.0.2.

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

Parameters:
absoluteabsolute

Set averaging criteria
Created in NX6.0.2.



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

Parameters:
averageaverage
void NXOpen::CAE::ResultParameters::SetBeamFilletRadius ( double  beamFilletRadius)

Sets the fillet radius as a fraction of the adjacent dimensions
Created in NX7.5.0.



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

Parameters:
beamFilletRadiusbeam fillet radius

Sets the fillets flag
Created in NX7.5.0.



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

Parameters:
beamFilletsbeam fillets

Presents beam results in local coordinate system (if flag is true) or in the same coordinate system as the rest of the model
Created in NX7.5.0.



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

Parameters:
locallocal

Sets a flag to calculate beam stresses and strains from element forces and section geometry (if available).

Does not affect other result types and element types
Created in NX7.5.0.

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

Parameters:
calcBeamStrResultscalc beam str results

Set complex criteria
Created in NX6.0.2.



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

Parameters:
complexcomplex

Set computing type.


Created in NX7.5.1.

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

Parameters:
computeTypecompute type

Set result coordinate system
Created in NX6.0.2.



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

Parameters:
coordinatecoordinate

Set how element the result is defined This option is only valid for nodal and elemen-nodal result; dose not do anything for element result.


Created in NX6.0.2.

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

Parameters:
criteriacriteria

Exclude or include elements which are not visible for computing with sum option.


Created in NX7.5.1.

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

Parameters:
excludeElementsexclude elements

Set Result type
Created in NX7.5.0.



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

Parameters:
typetype
void NXOpen::CAE::ResultParameters::SetLoadcaseIteration ( int  loadcase,
int  iteration 
)

Set Current loadcase and iteration.

This method has been deprecated. This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .


Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Parameters:
loadcaseloadcase number varies from 0 to N-1
iterationiteration number varies from 0 to N-1

Sets the phase angle at which result will be evaluated.

This is only value if complex result is set to the PhaseAngle type
Created in NX6.0.2.

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

Parameters:
angleangle

Set section where beam results are defined
Created in NX7.5.0.



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

Parameters:
sectionsection

Set result component
Created in NX6.0.2.



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

Parameters:
componentcomponent

Set FE entity where the result is defined This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .


Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Parameters:
locationlocation

Set result quantity This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .


Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Parameters:
quantityquantity

Set section of a FE entity where the result is defined This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .


Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Parameters:
sectionsection

Set section where shell results are defined
Created in NX7.5.0.



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

Parameters:
sectionsection

Set Result type This method has been deprecated.

This functionality was moved to this class CAE::BaseResultType , which can be obtained by using CAE::ResultParameters::GetGenericResultType .


Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.2.

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

Parameters:
typetype

Set scale.

This will affect all subsequent result query.
Created in NX6.0.2.

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

Parameters:
scalescale
void NXOpen::CAE::ResultParameters::SetSectionPlyLayer ( int  section,
int  ply,
int  layer 
)

Set section, ply and layer
Created in NX6.0.2.



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

Parameters:
sectionsection
plyply
layerlayer

Set selected coordinate system in which results are to be presented Coordinate systems labels defined in a result file can be retrieved using CAE::Result::GetResultCoordinateSystems.


Created in NX7.5.1.

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

Parameters:
sourcesource
idid

Set the method used when calculating the absolute values for the derived components of CAE::Result::DataTypeTensor like CAE::Result::ComponentMaximumPrincipal.


Created in NX8.0.1.

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

Parameters:
absoluteabsolute

Set result unit
Created in NX6.0.2.



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

Parameters:
unitunit

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