NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAM::AlongMachineAxisMoveBuilder Class Reference

Represents Along MCS Axis Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateAlongMcsAxisMoveBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::AlongMachineAxisMoveBuilder:
NXOpen::CAM::MoveBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

double AAxis ()
 Returns the A position
Created in NX5.0.0. More...
 
bool AOutput ()
 Returns the A output
Created in NX5.0.0. More...
 
double BAxis ()
 Returns the B position
Created in NX5.0.0. More...
 
bool BOutput ()
 Returns the B output
Created in NX5.0.0. More...
 
double CAxis ()
 Returns the C position
Created in NX5.0.0. More...
 
bool COutput ()
 Returns the C output
Created in NX5.0.0. More...
 
void SetAAxis (double axisPosition)
 Sets the A position
Created in NX5.0.0. More...
 
void SetAOutput (bool output)
 Sets the A output
Created in NX5.0.0. More...
 
void SetBAxis (double axisPosition)
 Sets the B position
Created in NX5.0.0. More...
 
void SetBOutput (bool output)
 Sets the B output
Created in NX5.0.0. More...
 
void SetCAxis (double axisPosition)
 Sets the C position
Created in NX5.0.0. More...
 
void SetCOutput (bool output)
 Sets the C output
Created in NX5.0.0. More...
 
void SetXAxis (double axisPosition)
 Sets the X position
Created in NX5.0.0. More...
 
void SetXOutput (bool output)
 Sets the X output
Created in NX5.0.0. More...
 
void SetYAxis (double axisPosition)
 Sets the Y position
Created in NX5.0.0. More...
 
void SetYOutput (bool output)
 Sets the Y output
Created in NX5.0.0. More...
 
void SetZAxis (double axisPosition)
 Sets the Z position
Created in NX5.0.0. More...
 
void SetZOutput (bool output)
 Sets the Z output
Created in NX5.0.0. More...
 
double XAxis ()
 Returns the X position
Created in NX5.0.0. More...
 
bool XOutput ()
 Returns the X output
Created in NX5.0.0. More...
 
double YAxis ()
 Returns the Y position
Created in NX5.0.0. More...
 
bool YOutput ()
 Returns the Y output
Created in NX5.0.0. More...
 
double ZAxis ()
 Returns the Z position
Created in NX5.0.0. More...
 
bool ZOutput ()
 Returns the Z output
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::MoveBuilder
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...
 

Additional Inherited Members

- Public Types inherited from NXOpen::CAM::MoveBuilder
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...
 

Detailed Description

Represents Along MCS Axis Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateAlongMcsAxisMoveBuilder

Created in NX5.0.0.


Member Function Documentation

double NXOpen::CAM::AlongMachineAxisMoveBuilder::AAxis ( )

Returns the A position
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::AlongMachineAxisMoveBuilder::AOutput ( )

Returns the A output
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::AlongMachineAxisMoveBuilder::BAxis ( )

Returns the B position
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::AlongMachineAxisMoveBuilder::BOutput ( )

Returns the B output
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::AlongMachineAxisMoveBuilder::CAxis ( )

Returns the C position
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::AlongMachineAxisMoveBuilder::COutput ( )

Returns the C output
Created in NX5.0.0.



License requirements : None

void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetAAxis ( double  axisPosition)

Sets the A position
Created in NX5.0.0.



License requirements : None

Parameters
axisPositionaxis position
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetAOutput ( bool  output)

Sets the A output
Created in NX5.0.0.



License requirements : None

Parameters
outputoutput
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetBAxis ( double  axisPosition)

Sets the B position
Created in NX5.0.0.



License requirements : None

Parameters
axisPositionaxis position
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetBOutput ( bool  output)

Sets the B output
Created in NX5.0.0.



License requirements : None

Parameters
outputoutput
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetCAxis ( double  axisPosition)

Sets the C position
Created in NX5.0.0.



License requirements : None

Parameters
axisPositionaxis position
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetCOutput ( bool  output)

Sets the C output
Created in NX5.0.0.



License requirements : None

Parameters
outputoutput
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetXAxis ( double  axisPosition)

Sets the X position
Created in NX5.0.0.



License requirements : None

Parameters
axisPositionaxis position
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetXOutput ( bool  output)

Sets the X output
Created in NX5.0.0.



License requirements : None

Parameters
outputoutput
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetYAxis ( double  axisPosition)

Sets the Y position
Created in NX5.0.0.



License requirements : None

Parameters
axisPositionaxis position
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetYOutput ( bool  output)

Sets the Y output
Created in NX5.0.0.



License requirements : None

Parameters
outputoutput
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetZAxis ( double  axisPosition)

Sets the Z position
Created in NX5.0.0.



License requirements : None

Parameters
axisPositionaxis position
void NXOpen::CAM::AlongMachineAxisMoveBuilder::SetZOutput ( bool  output)

Sets the Z output
Created in NX5.0.0.



License requirements : None

Parameters
outputoutput
double NXOpen::CAM::AlongMachineAxisMoveBuilder::XAxis ( )

Returns the X position
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::AlongMachineAxisMoveBuilder::XOutput ( )

Returns the X output
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::AlongMachineAxisMoveBuilder::YAxis ( )

Returns the Y position
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::AlongMachineAxisMoveBuilder::YOutput ( )

Returns the Y output
Created in NX5.0.0.



License requirements : None

double NXOpen::CAM::AlongMachineAxisMoveBuilder::ZAxis ( )

Returns the Z position
Created in NX5.0.0.



License requirements : None

bool NXOpen::CAM::AlongMachineAxisMoveBuilder::ZOutput ( )

Returns the Z output
Created in NX5.0.0.



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.