NXOpen::SIM::KinematicAxisBuilder Class Reference

Represents the SimKimAxisBuilder class object. More...

Inheritance diagram for NXOpen::SIM::KinematicAxisBuilder:

Public Types
enum	AxisDirectionType {   AxisDirectionTypePositiveX, AxisDirectionTypeNegativeX, AxisDirectionTypePositiveY, AxisDirectionTypeNegativeY,   AxisDirectionTypePositiveZ, AxisDirectionTypeNegativeZ }
	The axis direction type. More...
enum	AxisMotionType { AxisMotionTypeLinearNcAxis, AxisMotionTypeRotaryNcAxis, AxisMotionTypeLinear, AxisMotionTypeRotary }
	The axis motions type. More...

Public Member Functions
NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType	Direction ()
	Returns the axis direction Created in NX7.5.0. More...
double	InitialValue ()
	Returns the initial value Created in NX7.5.0. More...
NXOpen::SIM::KinematicJunction *	Junction ()
	Returns the junction Created in NX7.5.0. More...
bool	Limit ()
	Returns the axis limits flag Created in NX7.5.0. More...
double	LowerLimit ()
	Returns the lower limit Created in NX7.5.0. More...
double	MaximumVelocity ()
	Returns the maximum velocity Created in NX7.5.0. More...
NXString	Name ()
	Returns the kinematic axis's name Created in NX7.5.0. More...
void	SetDirection (NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType axisDir)
	Sets the axis direction Created in NX7.5.0. More...
void	SetInitialValue (double initial)
	Sets the initial value Created in NX7.5.0. More...
void	SetJunction (NXOpen::SIM::KinematicJunction *jct)
	Sets the junction Created in NX7.5.0. More...
void	SetLimit (bool onOff)
	Sets the axis limits flag Created in NX7.5.0. More...
void	SetLowerLimit (double lower)
	Sets the lower limit Created in NX7.5.0. More...
void	SetMaximumVelocity (double velocity)
	Sets the maximum velocity Created in NX7.5.0. More...
void	SetName (const NXString &name)
	Sets the kinematic axis's name Created in NX7.5.0. More...
void	SetName (const char *name)
	Sets the kinematic axis's name Created in NX7.5.0. More...
void	SetType (NXOpen::SIM::KinematicAxisBuilder::AxisMotionType type)
	Sets the axis motion Created in NX7.5.0. More...
void	SetUpperLimit (double upper)
	Sets the upper limit Created in NX7.5.0. More...
NXOpen::SIM::KinematicAxisBuilder::AxisMotionType	Type ()
	Returns the axis motion Created in NX7.5.0. More...
double	UpperLimit ()
	Returns the upper limit Created in NX7.5.0. 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 the SimKimAxisBuilder class object.

Use the NXOpen::SIM::KinematicConfigurator class to create a KinematicAxisBuilder object.

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType

The axis direction type.

Enumerator
AxisDirectionTypePositiveX	positive X-axis
AxisDirectionTypeNegativeX	negative X-axis
AxisDirectionTypePositiveY	positive Y-axis
AxisDirectionTypeNegativeY	negative Y-axis
AxisDirectionTypePositiveZ	positive Z-axis
AxisDirectionTypeNegativeZ	negative Z-axis

enum NXOpen::SIM::KinematicAxisBuilder::AxisMotionType

The axis motions type.

Enumerator
AxisMotionTypeLinearNcAxis	linear NC-axis
AxisMotionTypeRotaryNcAxis	rotary NC-axis
AxisMotionTypeLinear	linear axis
AxisMotionTypeRotary	rotary axis

Member Function Documentation

NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType NXOpen::SIM::KinematicAxisBuilder::Direction

(

)

Returns the axis direction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

double NXOpen::SIM::KinematicAxisBuilder::InitialValue

(

)

Returns the initial value
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

NXOpen::SIM::KinematicJunction* NXOpen::SIM::KinematicAxisBuilder::Junction

(

)

Returns the junction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

bool NXOpen::SIM::KinematicAxisBuilder::Limit

(

)

Returns the axis limits flag
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

double NXOpen::SIM::KinematicAxisBuilder::LowerLimit

(

)

Returns the lower limit
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

double NXOpen::SIM::KinematicAxisBuilder::MaximumVelocity

(

)

Returns the maximum velocity
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

NXString NXOpen::SIM::KinematicAxisBuilder::Name

(

)

Returns the kinematic axis's name
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

void NXOpen::SIM::KinematicAxisBuilder::SetDirection

(

NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType

axisDir

)

Sets the axis direction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axisDir

the axis direction

void NXOpen::SIM::KinematicAxisBuilder::SetInitialValue

(

double

initial

)

Sets the initial value
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

initial

the initial value

void NXOpen::SIM::KinematicAxisBuilder::SetJunction

(

NXOpen::SIM::KinematicJunction *

jct

)

Sets the junction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

jct	the junction

void NXOpen::SIM::KinematicAxisBuilder::SetLimit

(

bool

onOff

)

Sets the axis limits flag
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

onOff

the axis limits flag

void NXOpen::SIM::KinematicAxisBuilder::SetLowerLimit

(

double

lower

)

Sets the lower limit
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

lower

the lower limit

void NXOpen::SIM::KinematicAxisBuilder::SetMaximumVelocity

(

double

velocity

)

Sets the maximum velocity
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

velocity

the maximum velocity

void NXOpen::SIM::KinematicAxisBuilder::SetName

(

const NXString &

name

)

Sets the kinematic axis's name
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

name	the axis's new name

void NXOpen::SIM::KinematicAxisBuilder::SetName

(

const char *

name

)

Sets the kinematic axis's name
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

name	the axis's new name

void NXOpen::SIM::KinematicAxisBuilder::SetType

(

NXOpen::SIM::KinematicAxisBuilder::AxisMotionType

type

)

Sets the axis motion
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

type	the axis type

void NXOpen::SIM::KinematicAxisBuilder::SetUpperLimit

(

double

upper

)

Sets the upper limit
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

upper

the upper limit

NXOpen::SIM::KinematicAxisBuilder::AxisMotionType NXOpen::SIM::KinematicAxisBuilder::Type

(

)

Returns the axis motion
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

double NXOpen::SIM::KinematicAxisBuilder::UpperLimit

(

)

Returns the upper limit
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

---

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

• SIM_KinematicAxisBuilder.hxx