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

This class is worked as a packet of information that can be be used to deform CAE::Post objects. More...

Inheritance diagram for NXOpen::CAE::DeformationParameters:
NXOpen::TaggedObject

List of all members.

Public Member Functions

NXOpen::CAE::Result::Complex ComplexCriterion ()
 Returns the complexity criterion.
NXOpen::CAE::Result::Component Component ()
 Returns the result component that is used for deforming the model.
NXOpen::CAE::Result::DeformationScale DeformationType ()
 Returns the type of scale used for deforming the model
Created in NX7.5.0.
NXOpen::CAE::BaseResultTypeGenericType ()
 Returns the result type that will be used for deforming the model
Created in NX7.5.0.
bool IsReferenceNode ()
 Returns a value of true means the reference node will be used
Created in NX7.5.2.
double PhaseAngle ()
 Returns the phase angle at which result will be evaluated and used for deformation.
int ReferenceNodeLabel ()
 Returns the node label which identifies the reference node used when deforming the model if CAE::DeformationParameters::IsReferenceNode is set to true
Created in NX7.5.2.
double Scale ()
 Returns the scale to be applied to the deformation value
Created in NX7.5.0.
void SetComplexCriterion (NXOpen::CAE::Result::Complex complex)
 Sets the complexity criterion.
void SetComponent (NXOpen::CAE::Result::Component component)
 Sets the result component that is used for deforming the model.
void SetDeformationType (NXOpen::CAE::Result::DeformationScale unit)
 Sets the type of scale used for deforming the model
Created in NX7.5.0.
void SetGenericType (NXOpen::CAE::BaseResultType *type)
 Sets the result type that will be used for deforming the model
Created in NX7.5.0.
void SetPhaseAngle (double angle)
 Sets the phase angle at which result will be evaluated and used for deformation.
void SetReferenceNode (bool isReferenceNode)
 Sets a value of true means the reference node will be used
Created in NX7.5.2.
void SetReferenceNodeLabel (int referenceNodeLabel)
 Sets the node label which identifies the reference node used when deforming the model if CAE::DeformationParameters::IsReferenceNode is set to true
Created in NX7.5.2.
void SetScale (double scale)
 Sets the scale to be applied to the deformation value
Created in NX7.5.0.

Detailed Description

This class is worked as a packet of information that can be be used to deform CAE::Post objects.


Use CAE::ResultManager to create an CAE::DeformationParameters


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

Created in NX7.5.0.


Member Function Documentation

Returns the complexity criterion.

If the result type is complex CAE::BaseResultType::Complex the complexity criterion defines which value is used for deformation(like CAE::Result::ComplexReal or CAE::Result::ComplexImaginary )
Created in NX7.5.0.

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

Returns the result component that is used for deforming the model.


Created in NX7.5.0.

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

Returns the type of scale used for deforming the model
Created in NX7.5.0.



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

Returns the result type that will be used for deforming the model
Created in NX7.5.0.



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

Returns a value of true means the reference node will be used
Created in NX7.5.2.



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

Returns the phase angle at which result will be evaluated and used for deformation.

If the result type is complex CAE::BaseResultType::Complex and the CAE::DeformationParameters::ComplexCriterion and CAE::DeformationParameters::SetComplexCriterion is set to CAE::Result::ComplexPhaseAngle , the Phaseangle will be used to evaluate the value of the complex result
Created in NX7.5.0.

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

Returns the node label which identifies the reference node used when deforming the model if CAE::DeformationParameters::IsReferenceNode is set to true
Created in NX7.5.2.



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

Returns the scale to be applied to the deformation value
Created in NX7.5.0.



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

Sets the complexity criterion.

If the result type is complex CAE::BaseResultType::Complex the complexity criterion defines which value is used for deformation(like CAE::Result::ComplexReal or CAE::Result::ComplexImaginary )
Created in NX7.5.0.

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

Parameters:
complexcomplex

Sets the result component that is used for deforming the model.


Created in NX7.5.0.

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

Parameters:
componentcomponent

Sets the type of scale used for deforming the model
Created in NX7.5.0.



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

Parameters:
unitunit

Sets the result type that will be used for deforming the model
Created in NX7.5.0.



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

Parameters:
typetype

Sets the phase angle at which result will be evaluated and used for deformation.

If the result type is complex CAE::BaseResultType::Complex and the CAE::DeformationParameters::ComplexCriterion and CAE::DeformationParameters::SetComplexCriterion is set to CAE::Result::ComplexPhaseAngle , the Phaseangle will be used to evaluate the value of the complex result
Created in NX7.5.0.

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

Parameters:
angleangle

Sets a value of true means the reference node will be used
Created in NX7.5.2.



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

Parameters:
isReferenceNodeisreferencenode

Sets the node label which identifies the reference node used when deforming the model if CAE::DeformationParameters::IsReferenceNode is set to true
Created in NX7.5.2.



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

Parameters:
referenceNodeLabelreferencenodelabel

Sets the scale to be applied to the deformation value
Created in NX7.5.0.



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

Parameters:
scalescale

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