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

Represents a function component setting of NXOpen::CAE::ResponseSimulation::NodalFunctionExcitation on one direction
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAE::ResponseSimulation::FunctionComponentData:
NXOpen::TaggedObject

Public Member Functions

bool Enable ()
 Returns the option to enable the function component to be used while evaluating
Created in NX5.0.0. More...
 
NXOpen::CAE::FunctionFunction ()
 Returns the function to be applied
Created in NX5.0.0. More...
 
NXOpen::CAE::ResponseSimulation::Excitation::Component GetComponentType ()
 Returns the component type. More...
 
double PhaseAngle ()
 Returns the phase angle. More...
 
double ScalarFactor ()
 Returns the scalar factor
Created in NX5.0.0. More...
 
void SetEnable (bool enableOption)
 Sets the option to enable the function component to be used while evaluating
Created in NX5.0.0. More...
 
void SetFunction (NXOpen::CAE::Function *excitationFunction)
 Sets the function to be applied
Created in NX5.0.0. More...
 
void SetPhaseAngle (double phaseAngle)
 Sets the phase angle. More...
 
void SetScalarFactor (double scalarFactor)
 Sets the scalar factor
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a function component setting of NXOpen::CAE::ResponseSimulation::NodalFunctionExcitation on one direction
Created in NX5.0.0.


Member Function Documentation

bool NXOpen::CAE::ResponseSimulation::FunctionComponentData::Enable ( )

Returns the option to enable the function component to be used while evaluating
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::CAE::Function* NXOpen::CAE::ResponseSimulation::FunctionComponentData::Function ( )

Returns the function to be applied
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::CAE::ResponseSimulation::Excitation::Component NXOpen::CAE::ResponseSimulation::FunctionComponentData::GetComponentType ( )

Returns the component type.

Returns

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")
double NXOpen::CAE::ResponseSimulation::FunctionComponentData::PhaseAngle ( )

Returns the phase angle.

Only available when the onwer event is NXOpen::CAE::ResponseSimulation::RSEvent::TypeTransient
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

double NXOpen::CAE::ResponseSimulation::FunctionComponentData::ScalarFactor ( )

Returns the scalar factor
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

void NXOpen::CAE::ResponseSimulation::FunctionComponentData::SetEnable ( bool  enableOption)

Sets the option to enable the function component to be used while evaluating
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
enableOptionenable option
void NXOpen::CAE::ResponseSimulation::FunctionComponentData::SetFunction ( NXOpen::CAE::Function excitationFunction)

Sets the function to be applied
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
excitationFunctionexcitation function
void NXOpen::CAE::ResponseSimulation::FunctionComponentData::SetPhaseAngle ( double  phaseAngle)

Sets the phase angle.

Only available when the onwer event is NXOpen::CAE::ResponseSimulation::RSEvent::TypeTransient
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
phaseAnglephase angle
void NXOpen::CAE::ResponseSimulation::FunctionComponentData::SetScalarFactor ( double  scalarFactor)

Sets the scalar factor
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
scalarFactorscalar factor

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