NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::MoveBuilder Class Reference

Represents Move Builder
This cannot be instantiated

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::MoveBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::AlongMachineAxisMoveBuilder NXOpen::CAM::AlongMcsAxisMoveBuilder NXOpen::CAM::AlongToolAxisMoveBuilder NXOpen::CAM::CircularAboutAxisMoveBuilder NXOpen::CAM::DeltaMoveBuilder NXOpen::CAM::FollowGeometryMoveBuilder NXOpen::CAM::MoveToPointBuilder NXOpen::CAM::NormalToToolAxisMoveBuilder NXOpen::CAM::ProbeCalibrateLengthMoveBuilder NXOpen::CAM::ProbeCalibrateSphereMoveBuilder NXOpen::CAM::ProbeCalibrateStylusMoveBuilder NXOpen::CAM::ProbeClearanceMoveBuilder NXOpen::CAM::ProbeInspectBorebossMoveBuilder NXOpen::CAM::ProbeInspectPointMoveBuilder NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder NXOpen::CAM::RotaryPointMoveBuilder NXOpen::CAM::RotaryPolarMoveBuilder NXOpen::CAM::RotateToolMoveBuilder NXOpen::CAM::TeachmodeEngageSettingsBuilder NXOpen::CAM::TeachmodeLinearMoveBuilder NXOpen::CAM::TeachmodeProfileMoveBuilder NXOpen::CAM::TeachmodeRetractSettingsBuilder NXOpen::CAM::UdeMoveBuilder NXOpen::CAM::UserDefinedMoveBuilder NXOpen::CAM::VectorDistanceMoveBuilder

List of all members.

Public Types

enum  Feed { FeedMotion, FeedCustom }
 the feed Type More...
enum  Motion {
  MotionRapid = 1, MotionEngage, MotionCut, MotionStepover,
  MotionRetract, MotionApproach, MotionTraversal, MotionDeparture,
  MotionReturn
}
 the motion Type More...

Public Member Functions

double FeedRate ()
 Returns the feed rate
Created in NX5.0.0.
NXOpen::CAM::MoveBuilder::Feed FeedType ()
 Returns the feed type
Created in NX5.0.0.
NXOpen::CAM::FeedRateUnit FeedUnit ()
 Returns the feed unit
Created in NX7.5.0.
NXOpen::CAM::UdeParameterGetUserParameter (const NXString &parameterName)
 Returns the custom parameter with the given name.
NXOpen::CAM::UdeParameterGetUserParameter (int index)
 Returns the parameter at the input index.
NXOpen::CAM::MoveBuilder::Motion MotionType ()
 Returns the motion type
Created in NX5.0.0.
int NumberOfUserParameters ()
 Returns the number of user parameters
Created in NX8.0.0.
bool ProtectedMove ()
 Returns the protected move status
Created in NX5.0.0.
void SetFeedRate (double feedRate)
 Sets the feed rate
Created in NX5.0.0.
void SetFeedType (NXOpen::CAM::MoveBuilder::Feed feedType)
 Sets the feed type
Created in NX5.0.0.
void SetFeedUnit (NXOpen::CAM::FeedRateUnit unit)
 Sets the feed unit
Created in NX7.5.0.
void SetMotionType (NXOpen::CAM::MoveBuilder::Motion motionType)
 Sets the motion type
Created in NX5.0.0.
void SetParent (NXOpen::CAM::CAMObject *parent)
 Set parent
Created in NX5.0.0.
void SetProtectedMove (bool protectedMove)
 Sets the protected move status
Created in NX5.0.0.
void SetSibling (NXOpen::CAM::CAMObject *sibling)
 Set sibling
Created in NX5.0.0.

Detailed Description

Represents Move Builder
This cannot be instantiated

Created in NX5.0.0.



Member Enumeration Documentation

the feed Type

Enumerator:
FeedMotion 

Motion.

FeedCustom 

Custom.

the motion Type

Enumerator:
MotionEngage 

Engage.

MotionCut 

Cut.

MotionStepover 

Stepover.

MotionRetract 

Retract.

MotionApproach 

Approach.

MotionTraversal 

Traversal.

MotionDeparture 

Departure.

MotionReturn 

Return.


Member Function Documentation

Returns the feed rate
Created in NX5.0.0.



License requirements : None

Returns the feed type
Created in NX5.0.0.



License requirements : None

Returns the feed unit
Created in NX7.5.0.



License requirements : None

Returns the custom parameter with the given name.

Returns:
the parameter
Created in NX8.0.0.

License requirements : None
Parameters:
parameterNamethe parameter name
NOTE: The full Unicode character set is not supported for this parameter.

Returns the parameter at the input index.

Returns:
the parameter
Created in NX8.0.0.

License requirements : None
Parameters:
indexthe parameter index

Returns the motion type
Created in NX5.0.0.



License requirements : None

Returns the number of user parameters
Created in NX8.0.0.



License requirements : None

Returns the protected move status
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::MoveBuilder::SetFeedRate ( double  feedRate)

Sets the feed rate
Created in NX5.0.0.



License requirements : None

Parameters:
feedRatefeed rate

Sets the feed type
Created in NX5.0.0.



License requirements : None

Parameters:
feedTypefeed type

Sets the feed unit
Created in NX7.5.0.



License requirements : None

Parameters:
unitthe new unit

Sets the motion type
Created in NX5.0.0.



License requirements : None

Parameters:
motionTypemotion type

Set parent
Created in NX5.0.0.



License requirements : None

Parameters:
parentthe parent object
void NXOpen::CAM::MoveBuilder::SetProtectedMove ( bool  protectedMove)

Sets the protected move status
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
protectedMoveprotected move

Set sibling
Created in NX5.0.0.



License requirements : None

Parameters:
siblingthe sibling object

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