Represents Move Builder
This cannot be instantiated

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::MoveBuilder:

Public Types
enum	Feed { FeedMotion, FeedCustom }
	the feed Type More...

enum	Motion { MotionRapid = 1, MotionEngage, MotionCut, MotionStepover, MotionRetract, MotionApproach, MotionTraversal, MotionDeparture, MotionReturn, MotionFirstCut }
	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::UdeParameter *	GetUserParameter (const NXString &parameterName)
	Returns the custom parameter with the given name.

NXOpen::CAM::UdeParameter *	GetUserParameter (const char *parameterName)
	Returns the custom parameter with the given name.

NXOpen::CAM::UdeParameter *	GetUserParameter (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.

void	SetSubopLabel (const NXString &subopLabel)
	Sets the subop label Created in NX8.5.1.

void	SetSubopLabel (const char *subopLabel)
	Sets the subop label Created in NX8.5.1.

NXString	SubopLabel ()
	Returns the subop label Created in NX8.5.1.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents Move Builder
This cannot be instantiated

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::MoveBuilder::Feed

the feed Type

Enumerator:

FeedMotion	Motion.
FeedCustom	Custom.

enum NXOpen::CAM::MoveBuilder::Motion

the motion Type

Enumerator:

MotionEngage	Engage.
MotionCut	Cut.
MotionStepover	Stepover.
MotionRetract	Retract.
MotionApproach	Approach.
MotionTraversal	Traversal.
MotionDeparture	Departure.
MotionReturn	Return.
MotionFirstCut	First Cut.

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

parameterName the parameter name
NOTE: The full Unicode character set is not supported for this parameter.

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

parameterName the parameter name
NOTE: The full Unicode character set is not supported for this parameter.

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

index the 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

feedRate feed rate

void NXOpen::CAM::MoveBuilder::SetFeedType ( NXOpen::CAM::MoveBuilder::Feed feedType )

Sets the feed type
Created in NX5.0.0.

License requirements : None

Parameters

feedType feed type

void NXOpen::CAM::MoveBuilder::SetFeedUnit ( NXOpen::CAM::FeedRateUnit unit )

Sets the feed unit
Created in NX7.5.0.

License requirements : None

Parameters

unit	the 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

motionType motion type

void NXOpen::CAM::MoveBuilder::SetParent ( NXOpen::CAM::CAMObject * parent )

Set parent
Created in NX5.0.0.

License requirements : None

Parameters

parent the 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

protectedMove protected move

void NXOpen::CAM::MoveBuilder::SetSibling ( NXOpen::CAM::CAMObject * sibling )

Set sibling
Created in NX5.0.0.

License requirements : None

Parameters

sibling the sibling object

void NXOpen::CAM::MoveBuilder::SetSubopLabel ( const NXString & subopLabel )

Sets the subop label
Created in NX8.5.1.

License requirements : None

Parameters

subopLabel subop label

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

Sets the subop label
Created in NX8.5.1.

License requirements : None

Parameters

subopLabel subop 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:

CAM_MoveBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation