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

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

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

Public Member Functions

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

Detailed Description

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


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


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

Created in NX7.5.0.

Member Function Documentation

NXOpen::CAE::Result::Complex NXOpen::CAE::DeformationParameters::ComplexCriterion ( )

Returns the complexity criterion.

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

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

NXOpen::CAE::Result::Component NXOpen::CAE::DeformationParameters::Component ( )

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")

NXOpen::CAE::Result::DeformationScale NXOpen::CAE::DeformationParameters::DeformationType ( )

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")

NXOpen::CAE::BaseResultType* NXOpen::CAE::DeformationParameters::GenericType ( )

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")

bool NXOpen::CAE::DeformationParameters::IsReferenceNode ( )

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")

double NXOpen::CAE::DeformationParameters::PhaseAngle ( )

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

If the result type is complex NXOpen::CAE::BaseResultType::Complex and the NXOpen::CAE::DeformationParameters::ComplexCriterion and NXOpen::CAE::DeformationParameters::SetComplexCriterion is set to NXOpen::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")

int NXOpen::CAE::DeformationParameters::ReferenceNodeLabel ( )

Returns the node label which identifies the reference node used when deforming the model if NXOpen::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")

double NXOpen::CAE::DeformationParameters::Scale ( )

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")

void NXOpen::CAE::DeformationParameters::SetComplexCriterion ( NXOpen::CAE::Result::Complex  complex)

Sets the complexity criterion.

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

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

Parameters
complexcomplex
void NXOpen::CAE::DeformationParameters::SetComponent ( NXOpen::CAE::Result::Component  component)

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
void NXOpen::CAE::DeformationParameters::SetDeformationType ( NXOpen::CAE::Result::DeformationScale  unit)

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
void NXOpen::CAE::DeformationParameters::SetGenericType ( NXOpen::CAE::BaseResultType type)

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
void NXOpen::CAE::DeformationParameters::SetPhaseAngle ( double  angle)

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

If the result type is complex NXOpen::CAE::BaseResultType::Complex and the NXOpen::CAE::DeformationParameters::ComplexCriterion and NXOpen::CAE::DeformationParameters::SetComplexCriterion is set to NXOpen::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
void NXOpen::CAE::DeformationParameters::SetReferenceNode ( bool  isReferenceNode)

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
void NXOpen::CAE::DeformationParameters::SetReferenceNodeLabel ( int  referenceNodeLabel)

Sets the node label which identifies the reference node used when deforming the model if NXOpen::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
void NXOpen::CAE::DeformationParameters::SetScale ( double  scale)

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