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

Represents a NXOpen::CAE::ResponseSimulation::SensorBuilder
To create a new instance of this class, use NXOpen::CAE::ResponseSimulation::SensorCollection::CreateSensorBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAE::ResponseSimulation::SensorBuilder:
NXOpen::CAE::ResponseSimulation::BaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

std::vector
< NXOpen::CAE::FENode * > 
GetSelectedNodes ()
 Returns the destination nodes. More...
 
bool ReverseNormalDirection ()
 Returns the option for reverse the normal direction. More...
 
NXOpen::CAE::ResponseSimulation::SensorCoordinateType SensorCoordinateType ()
 Returns the sensor's coordinate type
Created in NX5.0.0. More...
 
bool SensorDirectionX ()
 Returns the setting for x direction compontent of sensor. More...
 
bool SensorDirectionY ()
 Returns the setting for y direction compontent of sensor. More...
 
bool SensorDirectionZ ()
 Returns the setting for z direction compontent of sensor. More...
 
NXOpen::CAE::ResponseSimulation::SensorResultType SensorResultType ()
 Returns the sensor's result type
Created in NX5.0.0. More...
 
bool SensorRotationX ()
 Returns the setting for x rotation compontent of sensor. More...
 
bool SensorRotationY ()
 Returns the setting for y rotation compontent of sensor. More...
 
bool SensorRotationZ ()
 Returns the setting for z rotation compontent of sensor. More...
 
NXOpen::CAE::ResponseSimulation::SensorType SensorType ()
 Returns the sensor's type
Created in NX5.0.0. More...
 
NXOpen::DirectionSensorVector ()
 Returns the user defined direction. More...
 
void SetReverseNormalDirection (bool normalDirection)
 Sets the option for reverse the normal direction. More...
 
void SetSelectedNodes (const std::vector< NXOpen::CAE::FENode * > &destinationNodes)
 Sets the destination nodes
Created in NX5.0.0. More...
 
void SetSensorCoordinateType (NXOpen::CAE::ResponseSimulation::SensorCoordinateType coordinateType)
 Sets the sensor's coordinate type
Created in NX5.0.0. More...
 
void SetSensorDirectionX (bool directionX)
 Sets the setting for x direction compontent of sensor. More...
 
void SetSensorDirectionY (bool directionY)
 Sets the setting for y direction compontent of sensor. More...
 
void SetSensorDirectionZ (bool directionZ)
 Sets the setting for z direction compontent of sensor. More...
 
void SetSensorResultType (NXOpen::CAE::ResponseSimulation::SensorResultType resultType)
 Sets the sensor's result type
Created in NX5.0.0. More...
 
void SetSensorRotationX (bool rotationX)
 Sets the setting for x rotation compontent of sensor. More...
 
void SetSensorRotationY (bool rotationY)
 Sets the setting for y rotation compontent of sensor. More...
 
void SetSensorRotationZ (bool rotationZ)
 Sets the setting for z rotation compontent of sensor. More...
 
void SetSensorType (NXOpen::CAE::ResponseSimulation::SensorType sensorType)
 Sets the sensor's type
Created in NX5.0.0. More...
 
void SetSensorVector (NXOpen::Direction *sensorVector)
 Sets the user defined direction. More...
 
- Public Member Functions inherited from NXOpen::CAE::ResponseSimulation::BaseBuilder
NXOpen::CAE::ResponseSimulation::ObjectLabelObjectLabel ()
 Returns the object label
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 a NXOpen::CAE::ResponseSimulation::SensorBuilder
To create a new instance of this class, use NXOpen::CAE::ResponseSimulation::SensorCollection::CreateSensorBuilder

Created in NX5.0.0.


Member Function Documentation

std::vector<NXOpen::CAE::FENode *> NXOpen::CAE::ResponseSimulation::SensorBuilder::GetSelectedNodes ( )

Returns the destination nodes.

Returns

Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")
bool NXOpen::CAE::ResponseSimulation::SensorBuilder::ReverseNormalDirection ( )

Returns the option for reverse the normal direction.

Only available when the sensor type is CAE::ResponseSimulation::SensorTypeNormal
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::CAE::ResponseSimulation::SensorCoordinateType NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorCoordinateType ( )

Returns the sensor's coordinate type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorDirectionX ( )

Returns the setting for x direction compontent of sensor.

If true, the response on direction x will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorDirectionY ( )

Returns the setting for y direction compontent of sensor.

If true, the response on direction y will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorDirectionZ ( )

Returns the setting for z direction compontent of sensor.

If true, the response on direction z will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::CAE::ResponseSimulation::SensorResultType NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorResultType ( )

Returns the sensor's result type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorRotationX ( )

Returns the setting for x rotation compontent of sensor.

If true, the response on rotation x will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorRotationY ( )

Returns the setting for y rotation compontent of sensor.

If true, the response on rotation y will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

bool NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorRotationZ ( )

Returns the setting for z rotation compontent of sensor.

If true, the response on rotation z will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::CAE::ResponseSimulation::SensorType NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorType ( )

Returns the sensor's type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

NXOpen::Direction* NXOpen::CAE::ResponseSimulation::SensorBuilder::SensorVector ( )

Returns the user defined direction.

Only available when the sensor type is CAE::ResponseSimulation::SensorTypeDirection
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetReverseNormalDirection ( bool  normalDirection)

Sets the option for reverse the normal direction.

Only available when the sensor type is CAE::ResponseSimulation::SensorTypeNormal
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
normalDirectionnormal direction
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSelectedNodes ( 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::SensorBuilder::SetSensorCoordinateType ( NXOpen::CAE::ResponseSimulation::SensorCoordinateType  coordinateType)

Sets the sensor's coordinate type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
coordinateTypecoordinate type
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorDirectionX ( bool  directionX)

Sets the setting for x direction compontent of sensor.

If true, the response on direction x will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
directionXdirection x
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorDirectionY ( bool  directionY)

Sets the setting for y direction compontent of sensor.

If true, the response on direction y will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
directionYdirection y
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorDirectionZ ( bool  directionZ)

Sets the setting for z direction compontent of sensor.

If true, the response on direction z will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
directionZdirection z
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorResultType ( NXOpen::CAE::ResponseSimulation::SensorResultType  resultType)

Sets the sensor's result type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
resultTyperesult type
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorRotationX ( bool  rotationX)

Sets the setting for x rotation compontent of sensor.

If true, the response on rotation x will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
rotationXrotation x
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorRotationY ( bool  rotationY)

Sets the setting for y rotation compontent of sensor.

If true, the response on rotation y will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
rotationYrotation y
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorRotationZ ( bool  rotationZ)

Sets the setting for z rotation compontent of sensor.

If true, the response on rotation z will be calculated. Only available when the sensor type is CAE::ResponseSimulation::SensorTypeComponent
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
rotationZrotation z
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorType ( NXOpen::CAE::ResponseSimulation::SensorType  sensorType)

Sets the sensor's type
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
sensorTypesensor type
void NXOpen::CAE::ResponseSimulation::SensorBuilder::SetSensorVector ( NXOpen::Direction sensorVector)

Sets the user defined direction.

Only available when the sensor type is CAE::ResponseSimulation::SensorTypeDirection
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters
sensorVectorsensor vector

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