NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::SIM::KinematicAxisBuilder Class Reference

Represents the SimKimAxisBuilder class object. More...

Inheritance diagram for NXOpen::SIM::KinematicAxisBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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

Detailed Description

Represents the SimKimAxisBuilder class object.


Use the KinematicConfigurator class to create a KinematicAxisBuilder object.

Created in NX7.5.0.


Member Enumeration Documentation

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

The axis motions type.

Enumerator:
AxisMotionTypeLinearNcAxis 

linear NC-axis

AxisMotionTypeRotaryNcAxis 

rotary NC-axis

AxisMotionTypeLinear 

linear axis

AxisMotionTypeRotary 

rotary axis


Member Function Documentation

Returns the axis direction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Returns the initial value
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Returns the junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Returns the axis limits flag
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Returns the lower limit
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Returns the maximum velocity
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

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



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Sets the axis direction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
axisDirthe axis direction

Sets the initial value
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
initialthe initial value

Sets the junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
jctthe junction

Sets the axis limits flag
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
onOffthe axis limits flag

Sets the lower limit
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
lowerthe lower limit

Sets the maximum velocity
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
velocitythe maximum velocity

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



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
namethe axis's new name

Sets the axis motion
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
typethe axis type

Sets the upper limit
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
upperthe upper limit

Returns the axis motion
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Returns the upper limit
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.