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

This class represents the data of a Linear Motion
Created in NX10.0.1. More...

Inheritance diagram for NXOpen::CAM::PathLinearMotion:
NXOpen::TransientObject NXOpen::CAM::PathCircularMotion NXOpen::CAM::PathHelixMotion

Public Member Functions

NXOpen::CAM::PathContactMotionContactData ()
 Returns the contact motion if the motion is contact and Nothing if not
Created in NX11.0.2. More...
 
NXOpen::Point3d EndPoint ()
 Returns the end point of the motion
Created in NX10.0.1. More...
 
void GetFeedrate (double *feedValue, NXOpen::CAM::CamPathFeedUnitType *feedUnit)
 Get feed rate information
Created in NX10.0.1. More...
 
bool IsContact ()
 Returns the check to see if motion is contact
Created in NX11.0.2. More...
 
bool IsCustomFeedrate ()
 Returns the custom feed rate indicator
Created in NX10.0.1. More...
 
NXOpen::CAM::CamPathMotionType MotionType ()
 Returns the motion type
Created in NX10.0.1. More...
 
void SetContact (bool answer)
 Sets the check to see if motion is contact
Created in NX11.0.2. More...
 
void SetContactData (NXOpen::CAM::PathContactMotion *contactMotion)
 Sets the contact motion if the motion is contact and Nothing if not
Created in NX11.0.2. More...
 
void SetCustomFeedrate (bool isCustomFeedRate)
 Sets the custom feed rate indicator
Created in NX10.0.1. More...
 
void SetEndPoint (const NXOpen::Point3d &endPoint)
 Sets the end point of the motion
Created in NX10.0.1. More...
 
void SetFeedrate (double feedValue, NXOpen::CAM::CamPathFeedUnitType feedUnit)
 Set feed rate information. More...
 
void SetMotionType (NXOpen::CAM::CamPathMotionType motionType)
 Sets the motion type
Created in NX10.0.1. More...
 
void SetToolAxis (const NXOpen::Vector3d &toolAxis)
 Sets the tool axis of the motion
Created in NX10.0.1. More...
 
NXOpen::Vector3d ToolAxis ()
 Returns the tool axis of the motion
Created in NX10.0.1. More...
 
virtual ~PathLinearMotion ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class represents the data of a Linear Motion
Created in NX10.0.1.


Constructor & Destructor Documentation

virtual NXOpen::CAM::PathLinearMotion::~PathLinearMotion ( )
virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX10.0.1.

License requirements : None

Member Function Documentation

NXOpen::CAM::PathContactMotion* NXOpen::CAM::PathLinearMotion::ContactData ( )

Returns the contact motion if the motion is contact and Nothing if not
Created in NX11.0.2.



License requirements : None

NXOpen::Point3d NXOpen::CAM::PathLinearMotion::EndPoint ( )

Returns the end point of the motion
Created in NX10.0.1.



License requirements : None

void NXOpen::CAM::PathLinearMotion::GetFeedrate ( double *  feedValue,
NXOpen::CAM::CamPathFeedUnitType feedUnit 
)

Get feed rate information
Created in NX10.0.1.



License requirements : None

Parameters
feedValuefeedvalue
feedUnitfeedunit
bool NXOpen::CAM::PathLinearMotion::IsContact ( )

Returns the check to see if motion is contact
Created in NX11.0.2.



License requirements : None

bool NXOpen::CAM::PathLinearMotion::IsCustomFeedrate ( )

Returns the custom feed rate indicator
Created in NX10.0.1.



License requirements : None

NXOpen::CAM::CamPathMotionType NXOpen::CAM::PathLinearMotion::MotionType ( )

Returns the motion type
Created in NX10.0.1.



License requirements : None

void NXOpen::CAM::PathLinearMotion::SetContact ( bool  answer)

Sets the check to see if motion is contact
Created in NX11.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
answeranswer
void NXOpen::CAM::PathLinearMotion::SetContactData ( NXOpen::CAM::PathContactMotion contactMotion)

Sets the contact motion if the motion is contact and Nothing if not
Created in NX11.0.2.



License requirements : cam_base ("CAM BASE")

Parameters
contactMotioncontactmotion
void NXOpen::CAM::PathLinearMotion::SetCustomFeedrate ( bool  isCustomFeedRate)

Sets the custom feed rate indicator
Created in NX10.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
isCustomFeedRateiscustomfeedrate
void NXOpen::CAM::PathLinearMotion::SetEndPoint ( const NXOpen::Point3d endPoint)

Sets the end point of the motion
Created in NX10.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
endPointendpoint
void NXOpen::CAM::PathLinearMotion::SetFeedrate ( double  feedValue,
NXOpen::CAM::CamPathFeedUnitType  feedUnit 
)

Set feed rate information.

If the feed rate is set on a motion then it will be treated as custom feed rate
Created in NX10.0.1.

License requirements : cam_base ("CAM BASE")

Parameters
feedValuefeedvalue
feedUnitfeedunit
void NXOpen::CAM::PathLinearMotion::SetMotionType ( NXOpen::CAM::CamPathMotionType  motionType)

Sets the motion type
Created in NX10.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
motionTypemotiontype
void NXOpen::CAM::PathLinearMotion::SetToolAxis ( const NXOpen::Vector3d toolAxis)

Sets the tool axis of the motion
Created in NX10.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
toolAxistoolaxis
NXOpen::Vector3d NXOpen::CAM::PathLinearMotion::ToolAxis ( )

Returns the tool axis of the motion
Created in NX10.0.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.