NXOpen::Mechatronics::PositionSensorBuilder Class Reference

Represents a NXOpen::Mechatronics::PositionSensor builder. More...

Inheritance diagram for NXOpen::Mechatronics::PositionSensorBuilder:

Public Types
enum	AxisJointType { AxisJointTypeAngular, AxisJointTypeLinear }
	the Axis Joint types. More...
enum	OutputMeasureType { OutputMeasureTypeConstant, OutputMeasureTypeVoltage, OutputMeasureTypeCurrent }
	the Measure types. More...

Public Member Functions
NXOpen::SelectNXObject *	AxisJoint ()
	Returns. More...
NXOpen::Mechatronics::PositionSensorBuilder::AxisJointType	AxisType ()
	Returns. More...
NXOpen::Expression *	LowerOutputRange ()
	Returns. More...
NXOpen::Expression *	LowerTrimRange ()
	Returns. More...
NXOpen::Mechatronics::PositionSensorBuilder::OutputMeasureType	MeasureType ()
	Returns. More...
void	SetAxisType (NXOpen::Mechatronics::PositionSensorBuilder::AxisJointType axisType)
	Sets. More...
void	SetMeasureType (NXOpen::Mechatronics::PositionSensorBuilder::OutputMeasureType measureType)
	Sets. More...
void	SetUseScale (bool useScale)
	Sets. More...
void	SetUseTrim (bool useTrim)
	Sets. More...
NXOpen::Expression *	UpperOutputRange ()
	Returns. More...
NXOpen::Expression *	UpperTrimRange ()
	Returns. More...
bool	UseScale ()
	Returns. More...
bool	UseTrim ()
	Returns. More...
Public Member Functions inherited from NXOpen::Mechatronics::PhysicsConstraintBuilder
NXString	Name ()
	Returns the name. More...
void	SetName (const NXString &name)
	Sets the name. More...
void	SetName (const char *name)
	Sets the name. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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::Mechatronics::PositionSensor builder.

To create a new instance of this class, use NXOpen::Mechatronics::PositionSensorCollection::CreatePositionSensorBuilder

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::PositionSensorBuilder::AxisJointType

the Axis Joint types.

Enumerator
AxisJointTypeAngular	Angular.
AxisJointTypeLinear	Linear.

enum NXOpen::Mechatronics::PositionSensorBuilder::OutputMeasureType

the Measure types.

Enumerator
OutputMeasureTypeConstant	MEASURE_UNITLESS.
OutputMeasureTypeVoltage	MEASURE_VOLTAGE.
OutputMeasureTypeCurrent	MEASURE_ELECTRIC_CURRENT.

Member Function Documentation

NXOpen::SelectNXObject* NXOpen::Mechatronics::PositionSensorBuilder::AxisJoint

(

)

Returns.

the joint select. This can be a NXOpen::Mechatronics::HingeJoint , NXOpen::Mechatronics::SlidingJoint , NXOpen::Mechatronics::CylindricalJoint , NXOpen::Mechatronics::PointOnCurveJoint and NXOpen::Mechatronics::PositionControl .

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::PositionSensorBuilder::AxisJointType NXOpen::Mechatronics::PositionSensorBuilder::AxisType

(

)

Returns.

the axis type.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::PositionSensorBuilder::LowerOutputRange

(

)

Returns.

the lower output range used to scale the position data. Its measure type contains constant, voltage, current

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::PositionSensorBuilder::LowerTrimRange

(

)

Returns.

the lower trim range used to trim the position data.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::PositionSensorBuilder::OutputMeasureType NXOpen::Mechatronics::PositionSensorBuilder::MeasureType

(

)

Returns.

the measure type.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::PositionSensorBuilder::SetAxisType

(

NXOpen::Mechatronics::PositionSensorBuilder::AxisJointType

axisType

)

Sets.

the axis type.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

axisType

axistype

void NXOpen::Mechatronics::PositionSensorBuilder::SetMeasureType

(

NXOpen::Mechatronics::PositionSensorBuilder::OutputMeasureType

measureType

)

Sets.

the measure type.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

measureType

measuretype

void NXOpen::Mechatronics::PositionSensorBuilder::SetUseScale

(

bool

useScale

)

Sets.

the use scale flag, which is used to control if the position sensor includes scale parameters.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

useScale

usescale

void NXOpen::Mechatronics::PositionSensorBuilder::SetUseTrim

(

bool

useTrim

)

Sets.

the use trim flag, which is used to control if the position sensor includes trim parameters.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

useTrim

usetrim

NXOpen::Expression* NXOpen::Mechatronics::PositionSensorBuilder::UpperOutputRange

(

)

Returns.

the upper output range used to scale the position data.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::PositionSensorBuilder::UpperTrimRange

(

)

Returns.

the upper trim range used to trim the position data.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::PositionSensorBuilder::UseScale

(

)

Returns.

the use scale flag, which is used to control if the position sensor includes scale parameters.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::PositionSensorBuilder::UseTrim

(

)

Returns.

the use trim flag, which is used to control if the position sensor includes trim parameters.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

---

The documentation for this class was generated from the following file:

• Mechatronics_PositionSensorBuilder.hxx