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:

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::BaseResultType *	GenericType ()
	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.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

   <br/>Use @link CAE::ResultManager CAE::ResultManager@endlink  to create an @link CAE::DeformationParameters CAE::DeformationParameters@endlink 

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

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

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 @link CAE::BaseResultType::Complex CAE::BaseResultType::Complex@endlink 
      and the @link CAE::DeformationParameters::ComplexCriterion CAE::DeformationParameters::ComplexCriterion @endlink and @link CAE::DeformationParameters::SetComplexCriterion CAE::DeformationParameters::SetComplexCriterion @endlink  is set to 
      @link CAE::Result::ComplexPhaseAngle CAE::Result::ComplexPhaseAngle@endlink  , 
      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 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 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

complex complex

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

component component

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

unit unit

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

type type

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 @link CAE::BaseResultType::Complex CAE::BaseResultType::Complex@endlink 
      and the @link CAE::DeformationParameters::ComplexCriterion CAE::DeformationParameters::ComplexCriterion @endlink and @link CAE::DeformationParameters::SetComplexCriterion CAE::DeformationParameters::SetComplexCriterion @endlink  is set to 
      @link CAE::Result::ComplexPhaseAngle CAE::Result::ComplexPhaseAngle@endlink  , 
      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

angle angle

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

isReferenceNode isreferencenode

void NXOpen::CAE::DeformationParameters::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.

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

Parameters

referenceNodeLabel referencenodelabel

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

scale scale

The documentation for this class was generated from the following file:

CAE_DeformationParameters.hxx

Public Member Functions

Detailed Description

Member Function Documentation