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

Represents the abstract builder class of evaluation setting for peak value, RMS results and LCR results. More...

Inheritance diagram for NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder:
NXOpen::CAE::ResponseSimulation::DynamicResultEvaluationSettingBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAE::ResponseSimulation::PeakValueEvaluationSettingBuilder NXOpen::CAE::ResponseSimulation::RmsResultsEvaluationSettingBuilder NXOpen::CAE::ResponseSimulation::LcrResultsEvaluationSettingBuilder

Public Member Functions

NXOpen::CAE::ResponseSimulation::CoordinateSystem CoordinateSystem ()
 Returns the coordinate system. More...
 
std::vector
< NXOpen::CAE::ResponseSimulation::DirectionDataComponent
GetDataComponents ()
 Returns the direction data components. More...
 
std::vector
< NXOpen::CAE::FEElement * > 
GetOutputElements ()
 Returns the destination elements. More...
 
std::vector
< NXOpen::CAE::FENode * > 
GetOutputNodes ()
 Returns the destination nodes. More...
 
NXOpen::CAE::FENodeObservationNode ()
 Returns the relative node.Only available when result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeDisplacement , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeAcceleration , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeElementForce. More...
 
bool Relative ()
 Returns the option of using the observation node in evaluation. More...
 
NXOpen::CAE::ResponseSimulation::EvaluationResultType ResultType ()
 Returns the result type
Created in NX5.0.0. More...
 
void SetCoordinateSystem (NXOpen::CAE::ResponseSimulation::CoordinateSystem coordinateSystem)
 Sets the coordinate system. More...
 
void SetDataComponents (const std::vector< NXOpen::CAE::ResponseSimulation::DirectionDataComponent > &dataComponent)
 Sets the direction data components. More...
 
void SetObservationNode (NXOpen::CAE::FENode *relativeNode)
 Sets the relative node.Only available when result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeDisplacement , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeAcceleration , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeElementForce. More...
 
void SetOutputElements (const std::vector< NXOpen::CAE::FEElement * > &destinationElements)
 Sets the destination elements
Created in NX5.0.0. More...
 
void SetOutputNodes (const std::vector< NXOpen::CAE::FENode * > &destinationNodes)
 Sets the destination nodes
Created in NX5.0.0. More...
 
void SetRelative (bool relative)
 Sets the option of using the observation node in evaluation. More...
 
void SetResultType (NXOpen::CAE::ResponseSimulation::EvaluationResultType resultType)
 Sets the result type
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::ResponseSimulation::DynamicResultEvaluationSettingBuilder
std::vector< NXStringGetDescriptionString ()
 Returns the description. More...
 
void SetDescriptionString (const std::vector< NXString > &description)
 Sets the description
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the abstract builder class of evaluation setting for peak value, RMS results and LCR results.


This is an abstract class, and cannot be created.

Created in NX5.0.0.

Member Function Documentation

NXOpen::CAE::ResponseSimulation::CoordinateSystem NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::CoordinateSystem ( )

Returns the coordinate system.

Only available when the result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeStress , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeShellResultant


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

std::vector<NXOpen::CAE::ResponseSimulation::DirectionDataComponent> NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::GetDataComponents ( )

Returns the direction data components.

The condidate choices will be changed according to NXOpen::CAE::ResponseSimulation::EvaluationResultType setting

Returns

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")
std::vector<NXOpen::CAE::FEElement *> NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::GetOutputElements ( )

Returns the destination elements.

Only available when the result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeStress , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeShellResultant

Returns

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")
std::vector<NXOpen::CAE::FENode *> NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::GetOutputNodes ( )

Returns the destination nodes.

Only available when result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeDisplacement , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeAcceleration , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeElementForce

Returns

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")
NXOpen::CAE::FENode* NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::ObservationNode ( )

Returns the relative node.Only available when result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeDisplacement , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeAcceleration , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeElementForce.


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::Relative ( )

Returns the option of using the observation node in evaluation.


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::CAE::ResponseSimulation::EvaluationResultType NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::ResultType ( )

Returns the result type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetCoordinateSystem ( NXOpen::CAE::ResponseSimulation::CoordinateSystem  coordinateSystem)

Sets the coordinate system.

Only available when the result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeStress , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeShellResultant


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
coordinateSystemcoordinate system
void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetDataComponents ( const std::vector< NXOpen::CAE::ResponseSimulation::DirectionDataComponent > &  dataComponent)

Sets the direction data components.

The condidate choices will be changed according to NXOpen::CAE::ResponseSimulation::EvaluationResultType setting


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
dataComponentdata component
void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetObservationNode ( NXOpen::CAE::FENode relativeNode)

Sets the relative node.Only available when result type is NXOpen::CAE::ResponseSimulation::EvaluationResultTypeDisplacement , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeAcceleration , NXOpen::CAE::ResponseSimulation::EvaluationResultTypeElementForce.


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
relativeNoderelative node
void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetOutputElements ( const std::vector< NXOpen::CAE::FEElement * > &  destinationElements)

Sets the destination elements
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
destinationElementsdestination elements
void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetOutputNodes ( const std::vector< NXOpen::CAE::FENode * > &  destinationNodes)

Sets the destination nodes
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
destinationNodesdestination nodes
void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetRelative ( bool  relative)

Sets the option of using the observation node in evaluation.


Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
relativerelative
void NXOpen::CAE::ResponseSimulation::PrlResultsEvaluationSettingBuilder::SetResultType ( NXOpen::CAE::ResponseSimulation::EvaluationResultType  resultType)

Sets the result type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
resultTyperesult type

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