NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::ResponseSimulation::RSEvent Class Reference

Represents a response analysis event. More...

Inheritance diagram for NXOpen::CAE::ResponseSimulation::RSEvent:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  AnalysisType { AnalysisTypeModeAcceleration, AnalysisTypeModeDisplacement }
 the analysis type of response analysis event. More...
enum  DdamFormulationType { DdamFormulationTypeStandard, DdamFormulationTypeUserDefined }
 Represents the fromulation type. More...
enum  ResultFileType { ResultFileTypeModalResponse, ResultFileTypeFunctionResponse, ResultFileTypeDynamicResponse }
 the result file type of event. More...
enum  SpacingType { SpacingTypeEven, SpacingTypeUneven }
 the spacing type. More...
enum  Type {
  TypeTransient, TypeFrequency, TypeRandom, TypeResponseSpectrum,
  TypeDdam, TypeStatic
}
 the type of reponse analysis event More...

Public Member Functions

void Destroy (bool deleteResultFile)
 Deletes a response simulation dynamic event, including all excitations under it
Created in NX5.0.0.
void EvaluateCsd (NXOpen::CAE::ResponseSimulation::CsdEvaluationSetting *evaluationSetting)
 Performs evaluation for CSD.
void EvaluateElementalFunctionResponse (NXOpen::CAE::ResponseSimulation::ElementalFunctionEvaluationSetting *evaluationSetting)
 Performs evaluation for elemental function response.
void EvaluateLcrResults (NXOpen::CAE::ResponseSimulation::LcrResultsEvaluationSetting *evaluationSetting)
 Performs evaluation for LCR results.
void EvaluateModalFunctionResponse ()
 Performs evaluation for modal function response.
void EvaluateModalResponse ()
 Performs evaluation for modal response.
void EvaluateNodalFunctionResponse (NXOpen::CAE::ResponseSimulation::NodalFunctionEvaluationSetting *evaluationSetting)
 Performs evaluation for nodal function response.
void EvaluatePeakValueResults (NXOpen::CAE::ResponseSimulation::PeakValueEvaluationSetting *evaluationSetting)
 Performs evaluation for peak value results.
void EvaluateResponseResults (NXOpen::CAE::ResponseSimulation::ResponseResultsEvaluationSetting *evaluationSetting)
 Performs evaluation for response results.
void EvaluateRmsResults (NXOpen::CAE::ResponseSimulation::RmsResultsEvaluationSetting *evaluationSetting)
 Perfroms evaluation for RMS results.
void EvaluateSensorResponse ()
 Performs evaluation for sensor response.
void EvaluateSensorResponse (NXOpen::CAE::ResponseSimulation::SensorEvaluationSetting *evaluationSetting)
 Performs evaluation for sensor response.
void EvaluateStrainGageResponse (NXOpen::CAE::ResponseSimulation::StrainGageEvaluationSetting *evaluationSetting)
 Performs evaluation for strain gage response.
void EvaluateStrengthResults (NXOpen::CAE::ResponseSimulation::StrengthResultsEvaluationSetting *evaluationSetting)
 Performs evaluation for strength results.
void Export (const NXString &eventDefinitionFile)
 Exports event definition to a XML file
Created in NX5.0.0.
bool GetCalculateStaticOffset ()
 Returns the option setting for calculating static offset result.
NXString GetEventName ()
 Returns the event name.
std::vector
< NXOpen::CAE::ResponseSimulation::Excitation * > 
GetExcitations ()
 Returns all excitations of an event.
NXString GetResultFileName (NXOpen::CAE::ResponseSimulation::RSEvent::ResultFileType resultFileType)
 Returns result file name of specified type.
NXOpen::CAE::ResponseSimulation::RSEventSolverParametersGetSolverParameters ()
 Returns the solver parameters.
void SetCalculateStaticOffset (bool calculateStaticOffset)
 Set the option setting for calculating static offset result.
void SetEventName (const NXString &eventName, bool renameResultFile)
 Sets the event name
Created in NX5.0.0.

Detailed Description

Represents a response analysis event.


Member Enumeration Documentation

the analysis type of response analysis event.

Only available for CAE::ResponseSimulation::RSEvent::TypeTransient and CAE::ResponseSimulation::RSEvent::TypeFrequency

Enumerator:
AnalysisTypeModeAcceleration 

mode acceleration

AnalysisTypeModeDisplacement 

mode displacement

Represents the fromulation type.

Enumerator:
DdamFormulationTypeStandard 

standard

DdamFormulationTypeUserDefined 

user defined

the result file type of event.

Enumerator:
ResultFileTypeModalResponse 

Result file to be used as Restart File, which extension is ".eef" or ".sef".

ResultFileTypeFunctionResponse 

Result file to contain function response evaluation results, which extenstion is ".afu".

ResultFileTypeDynamicResponse 

Result file to contain dynamic response evaluation results, which extension is ".rs2".

the spacing type.

Enumerator:
SpacingTypeEven 

even

SpacingTypeUneven 

uneven

the type of reponse analysis event

Enumerator:
TypeTransient 

transient

TypeFrequency 

frequency

TypeRandom 

random

TypeResponseSpectrum 

response spectrum

TypeDdam 

ddam

TypeStatic 

static


Member Function Documentation

void NXOpen::CAE::ResponseSimulation::RSEvent::Destroy ( bool  deleteResultFile)

Deletes a response simulation dynamic event, including all excitations under it
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
deleteResultFiledelete the result files associated with the solution or not

Performs evaluation for CSD.

The evaluation results will be stored in an AFU file, which name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for elemental function response.

The results is stored in an AFU file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for LCR results.

The results is stored in an RS2 file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for modal function response.

The results is stored in an AFU file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Performs evaluation for modal response.

The results is getting eef file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Performs evaluation for nodal function response.

The results is stored in an AFU file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for peak value results.

The results is stored in an RS2 file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName .
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for response results.

The results is stored in an RS2 file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName .
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Perfroms evaluation for RMS results.

The results is stored in an RS2 file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName .
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for sensor response.

The results is stored in an AFU file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Performs evaluation for sensor response.

The results is stored in an AFU file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for strain gage response.

The results is stored in an AFU file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting

Performs evaluation for strength results.

The results is stored in an RS2 file, which file name could be returned by CAE::ResponseSimulation::RSEvent::GetResultFileName .
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
evaluationSettingevaluation setting
void NXOpen::CAE::ResponseSimulation::RSEvent::Export ( const NXString eventDefinitionFile)

Exports event definition to a XML file
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
eventDefinitionFile
NOTE: The full Unicode character set is not supported for this parameter.

Returns the option setting for calculating static offset result.

The staic offset calculation is only available to transient event

Returns:

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns the event name.

Returns:

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns all excitations of an event.

Returns:

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns result file name of specified type.

Returns:

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")
Parameters:
resultFileTyperesult file type

Returns the solver parameters.

Returns:

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Set the option setting for calculating static offset result.

The static offset calculation is only available to transient event
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
calculateStaticOffsetcalculatestaticoffset
void NXOpen::CAE::ResponseSimulation::RSEvent::SetEventName ( const NXString eventName,
bool  renameResultFile 
)

Sets the event name
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
eventName
NOTE: The full Unicode character set is not supported for this parameter.
renameResultFileif there are result files associated with the event, rename them or not

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