NX Open C++ Reference Guide: NXOpen::Mechatronics::DistanceSensorBuilder Class Reference

NX Open C++ Reference Guide

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

Inheritance diagram for NXOpen::Mechatronics::DistanceSensorBuilder:

Public Types
enum	OutputMeasureType { OutputMeasureTypeConstant, OutputMeasureTypeVoltage, OutputMeasureTypeCurrent }
	the Measure types. More...

Public Member Functions
NXOpen::Expression *	Angle ()
	Returns. More...

int	Category ()
	Returns. More...

NXOpen::Direction *	Direction ()
	Returns. More...

bool	HighlightOnCollision ()
	Returns. More...

NXOpen::Expression *	LowerOutputRange ()
	Returns. More...

NXOpen::Mechatronics::DistanceSensorBuilder::OutputMeasureType	MeasureType ()
	Returns. More...

NXString	Name ()
	Returns. More...

NXOpen::Point *	Point ()
	Returns. More...

NXOpen::Expression *	Range ()
	Returns. More...

NXOpen::Mechatronics::SelectRigidBody *	RigidBody ()
	Returns. More...

void	SetCategory (int category)
	Sets. More...

void	SetDirection (NXOpen::Direction *direction)
	Sets. More...

void	SetHighlightOnCollision (bool highlight)
	Sets. More...

void	SetMeasureType (NXOpen::Mechatronics::DistanceSensorBuilder::OutputMeasureType measureType)
	Sets. More...

void	SetName (const NXString &name)
	Sets. More...

void	SetName (const char *name)
	Sets. More...

void	SetPoint (NXOpen::Point *point)
	Sets. More...

void	SetUseScale (bool useScale)
	Sets. More...

NXOpen::Expression *	UpperOutputRange ()
	Returns. More...

bool	UseScale ()
	Returns. 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::DistanceSensor builder.

To create a new instance of this class, use NXOpen::Mechatronics::DistanceSensorCollection::CreateDistanceSensorBuilder

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::DistanceSensorBuilder::OutputMeasureType

the Measure types.

Enumerator
OutputMeasureTypeConstant	MEASURE_UNITLESS.
OutputMeasureTypeVoltage	MEASURE_VOLTAGE.
OutputMeasureTypeCurrent	MEASURE_ELECTRIC_CURRENT.

Member Function Documentation

NXOpen::Expression* NXOpen::Mechatronics::DistanceSensorBuilder::Angle ( )

Returns.

the open angle. The angle between the cone surface and the Direction.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::DistanceSensorBuilder::Category ( )

Returns.

the category. It should be between 0 and 16.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Direction* NXOpen::Mechatronics::DistanceSensorBuilder::Direction ( )

Returns.

the direction. The Distance Sensor has the scope of a cone. The direction is the vector of the cone.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::DistanceSensorBuilder::HighlightOnCollision ( )

Returns.

the option of highlight on collision. If the highlight is true, then the sensor will be highlighted when it is collided or triggered during simulation.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::DistanceSensorBuilder::LowerOutputRange ( )

Returns.

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

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::DistanceSensorBuilder::OutputMeasureType NXOpen::Mechatronics::DistanceSensorBuilder::MeasureType ( )

Returns.

the measure type.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::DistanceSensorBuilder::Name ( )

Returns.

the name.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Point* NXOpen::Mechatronics::DistanceSensorBuilder::Point ( )

Returns.

the point. Sensor Reference Point, also used as start point to measure the distance

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::DistanceSensorBuilder::Range ( )

Returns.

the range of distance sensor. Also as the height of the cone

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SelectRigidBody* NXOpen::Mechatronics::DistanceSensorBuilder::RigidBody ( )

Returns.

the Rigid Body. This can be a NXOpen::Mechatronics::RigidBody If there is a rigid body, then the sensor will move with the rigid body.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::DistanceSensorBuilder::SetCategory ( int category )

Sets.

the category. It should be between 0 and 16.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

category category

void NXOpen::Mechatronics::DistanceSensorBuilder::SetDirection ( NXOpen::Direction * direction )

Sets.

the direction. The Distance Sensor has the scope of a cone. The direction is the vector of the cone.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

direction direction

void NXOpen::Mechatronics::DistanceSensorBuilder::SetHighlightOnCollision ( bool highlight )

Sets.

the option of highlight on collision. If the highlight is true, then the sensor will be highlighted when it is collided or triggered during simulation.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

highlight highlight

void NXOpen::Mechatronics::DistanceSensorBuilder::SetMeasureType ( NXOpen::Mechatronics::DistanceSensorBuilder::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::DistanceSensorBuilder::SetName ( const NXString & name )

Sets.

the name.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::DistanceSensorBuilder::SetName ( const char * name )

Sets.

the name.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name name

void NXOpen::Mechatronics::DistanceSensorBuilder::SetPoint ( NXOpen::Point * point )

Sets.

the point. Sensor Reference Point, also used as start point to measure the distance

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

point point

void NXOpen::Mechatronics::DistanceSensorBuilder::SetUseScale ( bool useScale )

Sets.

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

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

useScale usescale

NXOpen::Expression* NXOpen::Mechatronics::DistanceSensorBuilder::UpperOutputRange ( )

Returns.

the upper output range used to scale the distance data.

Created in NX11.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::DistanceSensorBuilder::UseScale ( )

Returns.

the use scale flag, which is used to control if the distance sensor includes scale 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_DistanceSensorBuilder.hxx

Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.