NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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::LaserCircleCutout NXOpen::CAM::LaserHexagonCutout NXOpen::CAM::LaserLinearMove NXOpen::CAM::LaserProfileMove NXOpen::CAM::LaserRectangleCutout NXOpen::CAM::LaserSlotCutout 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::ToolTrackingPointBuilder NXOpen::CAM::TurnMoveToPointBuilder NXOpen::CAM::TurnProbeClearanceBuilder NXOpen::CAM::TurnProbeInspectPointMoveBuilder NXOpen::CAM::UdeMoveBuilder NXOpen::CAM::UserDefinedMoveBuilder NXOpen::CAM::VectorDistanceMoveBuilder

Public Types

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

Public Member Functions

double FeedRate ()
 Returns the feed rate
Created in NX5.0.0. More...
 
NXOpen::CAM::MoveBuilder::Feed FeedType ()
 Returns the feed type
Created in NX5.0.0. More...
 
NXOpen::CAM::FeedRateUnit FeedUnit ()
 Returns the feed unit
Created in NX7.5.0. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (const NXString &parameterName)
 Returns the custom parameter with the given name. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (const char *parameterName)
 Returns the custom parameter with the given name. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (int index)
 Returns the parameter at the input index. More...
 
NXOpen::CAM::MoveBuilder::Motion MotionType ()
 Returns the motion type
Created in NX5.0.0. More...
 
int NumberOfUserParameters ()
 Returns the number of user parameters
Created in NX8.0.0. More...
 
bool ProtectedMove ()
 Returns the protected move status
Created in NX5.0.0. More...
 
void SetFeedRate (double feedRate)
 Sets the feed rate
Created in NX5.0.0. More...
 
void SetFeedType (NXOpen::CAM::MoveBuilder::Feed feedType)
 Sets the feed type
Created in NX5.0.0. More...
 
void SetFeedUnit (NXOpen::CAM::FeedRateUnit unit)
 Sets the feed unit
Created in NX7.5.0. More...
 
void SetMotionType (NXOpen::CAM::MoveBuilder::Motion motionType)
 Sets the motion type
Created in NX5.0.0. More...
 
void SetParent (NXOpen::CAM::CAMObject *parent)
 Set parent
Created in NX5.0.0. More...
 
void SetProtectedMove (bool protectedMove)
 Sets the protected move status
Created in NX5.0.0. More...
 
void SetSibling (NXOpen::CAM::CAMObject *sibling)
 Set sibling
Created in NX5.0.0. More...
 
void SetSubopLabel (const NXString &subopLabel)
 Sets the subop label
Created in NX8.5.1. More...
 
void SetSubopLabel (const char *subopLabel)
 Sets the subop label
Created in NX8.5.1. More...
 
NXString SubopLabel ()
 Returns the subop label
Created in NX8.5.1. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 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
MotionRapid 

Rapid.

MotionEngage 

Engage.

MotionCut 

Cut.

MotionStepover 

Stepover.

MotionRetract 

Retract.

MotionApproach 

Approach.

MotionTraversal 

Traversal.

MotionDeparture 

Departure.

MotionReturn 

Return.

MotionFirstCut 

First Cut.

MotionLastCut 

Last Cut.

MotionCrossover 

Crossover.

Member Function Documentation

double NXOpen::CAM::MoveBuilder::FeedRate ( )

Returns the feed rate
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::MoveBuilder::Feed NXOpen::CAM::MoveBuilder::FeedType ( )

Returns the feed type
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::FeedRateUnit NXOpen::CAM::MoveBuilder::FeedUnit ( )

Returns the feed unit
Created in NX7.5.0.



License requirements : None

NXOpen::CAM::UdeParameter* NXOpen::CAM::MoveBuilder::GetUserParameter ( const NXString parameterName)

Returns the custom parameter with the given name.

Returns
the parameter
Created in NX8.0.0.

License requirements : None
Parameters
parameterNamethe parameter name
NXOpen::CAM::UdeParameter* NXOpen::CAM::MoveBuilder::GetUserParameter ( const char *  parameterName)

Returns the custom parameter with the given name.

Returns
the parameter
Created in NX8.0.0.

License requirements : None
Parameters
parameterNamethe parameter name
NXOpen::CAM::UdeParameter* NXOpen::CAM::MoveBuilder::GetUserParameter ( int  index)

Returns the parameter at the input index.

Returns
the parameter
Created in NX8.0.0.

License requirements : None
Parameters
indexthe parameter index
NXOpen::CAM::MoveBuilder::Motion NXOpen::CAM::MoveBuilder::MotionType ( )

Returns the motion type
Created in NX5.0.0.



License requirements : None

int NXOpen::CAM::MoveBuilder::NumberOfUserParameters ( )

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



License requirements : None

bool NXOpen::CAM::MoveBuilder::ProtectedMove ( )

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
void NXOpen::CAM::MoveBuilder::SetFeedType ( NXOpen::CAM::MoveBuilder::Feed  feedType)

Sets the feed type
Created in NX5.0.0.



License requirements : None

Parameters
feedTypefeed type
void NXOpen::CAM::MoveBuilder::SetFeedUnit ( NXOpen::CAM::FeedRateUnit  unit)

Sets the feed unit
Created in NX7.5.0.



License requirements : None

Parameters
unitthe new unit
void NXOpen::CAM::MoveBuilder::SetMotionType ( NXOpen::CAM::MoveBuilder::Motion  motionType)

Sets the motion type
Created in NX5.0.0.



License requirements : None

Parameters
motionTypemotion type
void NXOpen::CAM::MoveBuilder::SetParent ( NXOpen::CAM::CAMObject parent)

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
void NXOpen::CAM::MoveBuilder::SetSibling ( NXOpen::CAM::CAMObject sibling)

Set sibling
Created in NX5.0.0.



License requirements : None

Parameters
siblingthe sibling object
void NXOpen::CAM::MoveBuilder::SetSubopLabel ( const NXString subopLabel)

Sets the subop label
Created in NX8.5.1.



License requirements : None

Parameters
subopLabelsubop label
void NXOpen::CAM::MoveBuilder::SetSubopLabel ( const char *  subopLabel)

Sets the subop label
Created in NX8.5.1.



License requirements : None

Parameters
subopLabelsubop label
NXString NXOpen::CAM::MoveBuilder::SubopLabel ( )

Returns the subop label
Created in NX8.5.1.



License requirements : None


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