SensorBuilder Class

class NXOpen.CAE.ResponseSimulation.SensorBuilder

Bases: NXOpen.CAE.ResponseSimulation.BaseBuilder

Represents a NXOpen.CAE.ResponseSimulation.SensorBuilder

To create a new instance of this class, use NXOpen.CAE.ResponseSimulation.SensorCollection.CreateSensorBuilder()

New in version NX5.0.0.

Properties

Property	Description
ObjectLabel	Returns the object label
ReverseNormalDirection	Returns or sets the option for reverse the normal direction.
SensorCoordinateType	Returns or sets the sensor’s coordinate type
SensorDirectionX	Returns or sets the setting for x direction compontent of sensor.
SensorDirectionY	Returns or sets the setting for y direction compontent of sensor.
SensorDirectionZ	Returns or sets the setting for z direction compontent of sensor.
SensorResultType	Returns or sets the sensor’s result type
SensorRotationX	Returns or sets the setting for x rotation compontent of sensor.
SensorRotationY	Returns or sets the setting for y rotation compontent of sensor.
SensorRotationZ	Returns or sets the setting for z rotation compontent of sensor.
SensorType	Returns or sets the sensor’s type
SensorVector	Returns or sets the user defined direction.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetSelectedNodes	Returns the destination nodes
SetSelectedNodes	Sets the destination nodes
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ReverseNormalDirection

SensorBuilder.ReverseNormalDirection

Returns or sets the option for reverse the normal direction.

Only available when the sensor type is CAE.ResponseSimulationSensorType.Normal

-------------------------------------

Getter Method

Signature ReverseNormalDirection

Returns: Return type:bool

New in version NX6.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature ReverseNormalDirection

Parameters:normalDirection (bool) –

New in version NX6.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorCoordinateType

SensorBuilder.SensorCoordinateType

Returns or sets the sensor’s coordinate type

-------------------------------------

Getter Method

Signature SensorCoordinateType

Returns: Return type:NXOpen.CAE.ResponseSimulation.SensorCoordinateType

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorCoordinateType

Parameters:coordinateType (NXOpen.CAE.ResponseSimulation.SensorCoordinateType) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorDirectionX

SensorBuilder.SensorDirectionX

Returns or 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.ResponseSimulationSensorType.Component

-------------------------------------

Getter Method

Signature SensorDirectionX

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorDirectionX

Parameters:directionX (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorDirectionY

SensorBuilder.SensorDirectionY

Returns or 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.ResponseSimulationSensorType.Component

-------------------------------------

Getter Method

Signature SensorDirectionY

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorDirectionY

Parameters:directionY (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorDirectionZ

SensorBuilder.SensorDirectionZ

Returns or 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.ResponseSimulationSensorType.Component

-------------------------------------

Getter Method

Signature SensorDirectionZ

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorDirectionZ

Parameters:directionZ (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorResultType

SensorBuilder.SensorResultType

Returns or sets the sensor’s result type

-------------------------------------

Getter Method

Signature SensorResultType

Returns: Return type:NXOpen.CAE.ResponseSimulation.SensorResultType

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorResultType

Parameters:resultType (NXOpen.CAE.ResponseSimulation.SensorResultType) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorRotationX

SensorBuilder.SensorRotationX

Returns or 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.ResponseSimulationSensorType.Component

-------------------------------------

Getter Method

Signature SensorRotationX

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorRotationX

Parameters:rotationX (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorRotationY

SensorBuilder.SensorRotationY

Returns or 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.ResponseSimulationSensorType.Component

-------------------------------------

Getter Method

Signature SensorRotationY

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorRotationY

Parameters:rotationY (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorRotationZ

SensorBuilder.SensorRotationZ

Returns or 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.ResponseSimulationSensorType.Component

-------------------------------------

Getter Method

Signature SensorRotationZ

Returns: Return type:bool

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorRotationZ

Parameters:rotationZ (bool) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorType

SensorBuilder.SensorType

Returns or sets the sensor’s type

-------------------------------------

Getter Method

Signature SensorType

Returns: Return type:NXOpen.CAE.ResponseSimulation.SensorType

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorType

Parameters:sensorType (NXOpen.CAE.ResponseSimulation.SensorType) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SensorVector

SensorBuilder.SensorVector

Returns or sets the user defined direction.

Only available when the sensor type is CAE.ResponseSimulationSensorType.Direction

-------------------------------------

Getter Method

Signature SensorVector

Returns: Return type:NXOpen.Direction

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

-------------------------------------

Setter Method

Signature SensorVector

Parameters:sensorVector (NXOpen.Direction) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Method Detail

GetSelectedNodes

SensorBuilder.GetSelectedNodes

Returns the destination nodes

Signature GetSelectedNodes()

Returns: Return type:list of NXOpen.CAE.FENode

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

SetSelectedNodes

SensorBuilder.SetSelectedNodes

Sets the destination nodes

Signature SetSelectedNodes(destinationNodes)

Parameters:destinationNodes (list of NXOpen.CAE.FENode) –

New in version NX5.0.0.

License requirements: nx_response_anlys (“NX Response Analysis”)

Validate

SensorBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.