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,   AxisMotionTypeRotaryUnlimitedNcAxis, AxisMotionTypeSpindleNcAxis, AxisMotionTypeRotaryUnlimited, AxisMotionTypeSpindle }
	The axis motions type. More...

Public Member Functions
double	CoarsePrecision ()
	Returns the coarse precision. More...
NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType	Direction ()
	Returns the axis direction Created in NX7.5.0. More...
double	FinePrecision ()
	Returns the fine precision. More...
double	InitialValue ()
	Returns the initial value Created in NX7.5.0. More...
double	JerkLimit ()
	Returns the jerk limit. More...
double	JumpVelocity ()
	Returns the jump velocity. More...
NXOpen::SIM::KinematicJunction *	Junction ()
	Returns the junction Created in NX7.5.0. More...
double	Kv ()
	Returns the kv. More...
bool	Limit ()
	Returns the axis limits flag This property is deprecated. More...
double	LowerLimit ()
	Returns the lower limit Created in NX7.5.0. More...
double	LowerSoftLimit ()
	Returns the lower soft limit. More...
double	MaxAcceleration ()
	Returns the max acceleration. More...
double	MaxDeceleration ()
	Returns the max deceleration. 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...
int	Number ()
	Returns the kinematic axis's number. More...
void	SetCoarsePrecision (double coarse)
	Sets the coarse precision. More...
void	SetDirection (NXOpen::SIM::KinematicAxisBuilder::AxisDirectionType axisDir)
	Sets the axis direction Created in NX7.5.0. More...
void	SetFinePrecision (double fine)
	Sets the fine precision. More...
void	SetInitialValue (double initial)
	Sets the initial value Created in NX7.5.0. More...
void	SetJerkLimit (double jerk)
	Sets the jerk limit. More...
void	SetJumpVelocity (double jump)
	Sets the jump velocity. More...
void	SetJunction (NXOpen::SIM::KinematicJunction *jct)
	Sets the junction Created in NX7.5.0. More...
void	SetKv (double kv)
	Sets the kv. More...
void	SetLimit (bool onOff)
	Sets the axis limits flag This property is deprecated. More...
void	SetLowerLimit (double lower)
	Sets the lower limit Created in NX7.5.0. More...
void	SetLowerSoftLimit (double lower)
	Sets the lower soft limit. More...
void	SetMaxAcceleration (double max)
	Sets the max acceleration. More...
void	SetMaxDeceleration (double max)
	Sets the max deceleration. 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	SetNumber (int number)
	Sets the kinematic axis's number. 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...
void	SetUpperSoftLimit (double upper)
	Sets the upper soft limit. 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...
double	UpperSoftLimit ()
	Returns the upper soft limit. 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
AxisMotionTypeRotaryUnlimitedNcAxis	rotary unlimited NC-axis
AxisMotionTypeSpindleNcAxis	spindle NC-axis
AxisMotionTypeRotaryUnlimited	rotary axis unlimited
AxisMotionTypeSpindle	spindle

Member Function Documentation

double NXOpen::SIM::KinematicAxisBuilder::CoarsePrecision

(

)

Returns the coarse precision.

This defines the exact stop precision used to determine if a target point has been reached, so that the next NC-block can be executed.
Created in NX9.0.3.

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

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::FinePrecision

(

)

Returns the fine precision.

This defines the exact stop precision used to determine if a target point has been reached, so that the next NC-block can be executed.
Created in NX9.0.3.

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")

double NXOpen::SIM::KinematicAxisBuilder::JerkLimit

(

)

Returns the jerk limit.

The jerk limit value limits jumps in acceleration.
Created in NX9.0.3.

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

double NXOpen::SIM::KinematicAxisBuilder::JumpVelocity

(

)

Returns the jump velocity.

The jump velocity define a lag time at the beginning of the motion.
Created in NX9.0.3.

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")

double NXOpen::SIM::KinematicAxisBuilder::Kv

(

)

Returns the kv.

the Kv-Factor is a parameter of the drives. It influences the dragging error (difference between ideal motion profile and actual motion profile).
Created in NX9.0.3.

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
This property is deprecated.

Use SIM::KinematicAxisBuilder::AxisMotionType instead.

Deprecated:

Deprecated in NX9.0.3. Use SIM::KinematicAxisBuilder::AxisMotionType instead.

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::LowerSoftLimit

(

)

Returns the lower soft limit.

The soft limit on the real machine is checked by the controller to avoid that the machine travels into the mechanical stop (Hard Limit) with full speed (prevent damage)
Created in NX9.0.3.

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

double NXOpen::SIM::KinematicAxisBuilder::MaxAcceleration

(

)

Returns the max acceleration.

The maximum acceleration defines how fast the axis can accelerate.
Created in NX9.0.3.

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

double NXOpen::SIM::KinematicAxisBuilder::MaxDeceleration

(

)

Returns the max deceleration.

The maximum deceleration defines how fast the axis can decelerate.
Created in NX9.0.3.

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")

int NXOpen::SIM::KinematicAxisBuilder::Number

(

)

Returns the kinematic axis's number.

The axis number is used in cases where an axis is programmed through a number instead of through an address (e.g. on Siemens 840D: AX1=10 instead of X10).
Created in NX9.0.3.

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

void NXOpen::SIM::KinematicAxisBuilder::SetCoarsePrecision

(

double

coarse

)

Sets the coarse precision.

This defines the exact stop precision used to determine if a target point has been reached, so that the next NC-block can be executed.
Created in NX9.0.3.

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

Parameters

coarse

the Coarse Precision

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::SetFinePrecision

(

double

fine

)

Sets the fine precision.

This defines the exact stop precision used to determine if a target point has been reached, so that the next NC-block can be executed.
Created in NX9.0.3.

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

Parameters

fine	the Fine Precision

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::SetJerkLimit

(

double

jerk

)

Sets the jerk limit.

The jerk limit value limits jumps in acceleration.
Created in NX9.0.3.

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

Parameters

jerk	the jerk limit

void NXOpen::SIM::KinematicAxisBuilder::SetJumpVelocity

(

double

jump

)

Sets the jump velocity.

The jump velocity define a lag time at the beginning of the motion.
Created in NX9.0.3.

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

Parameters

jump	the Jump Velocity

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::SetKv

(

double

kv

)

Sets the kv.

the Kv-Factor is a parameter of the drives. It influences the dragging error (difference between ideal motion profile and actual motion profile).
Created in NX9.0.3.

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

Parameters

kv

the Kv

void NXOpen::SIM::KinematicAxisBuilder::SetLimit

(

bool

onOff

)

Sets the axis limits flag
This property is deprecated.

Use SIM::KinematicAxisBuilder::AxisMotionType instead.

Deprecated:

Deprecated in NX9.0.3. Use SIM::KinematicAxisBuilder::AxisMotionType instead.

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::SetLowerSoftLimit

(

double

lower

)

Sets the lower soft limit.

The soft limit on the real machine is checked by the controller to avoid that the machine travels into the mechanical stop (Hard Limit) with full speed (prevent damage)
Created in NX9.0.3.

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

Parameters

lower

the lower soft limit

void NXOpen::SIM::KinematicAxisBuilder::SetMaxAcceleration

(

double

max

)

Sets the max acceleration.

The maximum acceleration defines how fast the axis can accelerate.
Created in NX9.0.3.

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

Parameters

max	the Max Acceleration

void NXOpen::SIM::KinematicAxisBuilder::SetMaxDeceleration

(

double

max

)

Sets the max deceleration.

The maximum deceleration defines how fast the axis can decelerate.
Created in NX9.0.3.

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

Parameters

max	the Max Deceleration

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::SetNumber

(

int

number

)

Sets the kinematic axis's number.

The axis number is used in cases where an axis is programmed through a number instead of through an address (e.g. on Siemens 840D: AX1=10 instead of X10).
Created in NX9.0.3.

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

Parameters

number

the axis's new number

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

void NXOpen::SIM::KinematicAxisBuilder::SetUpperSoftLimit

(

double

upper

)

Sets the upper soft limit.

The soft limit on the real machine is checked by the controller to avoid that the machine travels into the mechanical stop (Hard Limit) with full speed (prevent damage)
Created in NX9.0.3.

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

Parameters

upper

the upper soft 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")

double NXOpen::SIM::KinematicAxisBuilder::UpperSoftLimit

(

)

Returns the upper soft limit.

The soft limit on the real machine is checked by the controller to avoid that the machine travels into the mechanical stop (Hard Limit) with full speed (prevent damage)
Created in NX9.0.3.

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