Represents an avoidance start Builder
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAM::TurnRoughFinishLocalReturnBuilder:

Public Types
enum	AdjustmentModeTypes { AdjustmentModeTypesNone, AdjustmentModeTypesRange, AdjustmentModeTypesAlignment }
	the adjustment mode options Created in NX6.0.0. More...

enum	DwellUnitTypes { DwellUnitTypesNone, DwellUnitTypesSeconds, DwellUnitTypesRevolutions }
	the Dwell Unit type Created in NX6.0.0. More...

enum	LimitTypes { LimitTypesDistanceOrTime, LimitTypesPercent }
	the local limit mode Created in NX6.0.0. More...

enum	ModeTypes { ModeTypesNone, ModeTypesDistance, ModeTypesTime, ModeTypesNumberOfPasses, ModeTypesNumberOfCuts, ModeTypesNumberOfLevels }
	The local return type options Created in NX6.0.0. More...

enum	ReturnMoveModeTypes { ReturnMoveModeTypesNone, ReturnMoveModeTypesDirect, ReturnMoveModeTypesRadialAxial, ReturnMoveModeTypesAxialRadial, ReturnMoveModeTypesClearRadialDirect, ReturnMoveModeTypesClearAxialDirect, ReturnMoveModeTypesClearRadial, ReturnMoveModeTypesClearAxial, ReturnMoveModeTypesRadialClearAxialDirect, ReturnMoveModeTypesRadialAxialRadial, ReturnMoveModeTypesRadialClearAxial, ReturnMoveModeTypesClearRadialClearAxialDirect, ReturnMoveModeTypesClearRadialAxialRadial, ReturnMoveModeTypesClearRadialClearAxial, ReturnMoveModeTypesSameAsDeparture }
	the return move mode options Created in NX6.0.0. More...

Public Member Functions
NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::AdjustmentModeTypes	AdjustmentMode ()
	Returns the adjustment mode mode Created in NX6.0.0.

double	Distance ()
	Returns the local distance value Created in NX6.0.0.

double	Dwell ()
	Returns the Dwell Time or Revolutions Created in NX6.0.0.

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::DwellUnitTypes	DwellUnit ()
	Returns the Dwell Unit type Created in NX6.0.0.

NXOpen::CAM::PostEventsCiBuilder *	EndOfPathBuilder ()
	Returns the end event builder Created in NX6.0.0.

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes	GetLowerLimitType ()
	Get the lower limits mode.

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes	GetUpperLimitType ()
	Get the upper limits mode.

double	LowerLimit ()
	Returns the lower limit Created in NX6.0.0.

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ModeTypes	Mode ()
	Returns the local return type Created in NX6.0.0.

int	NumberOfCuts ()
	Returns the local number of cuts Created in NX6.0.0.

int	NumberOfLevels ()
	Returns the local number of levels Created in NX6.0.0.

int	NumberOfPasses ()
	Returns the local number of passes value Created in NX6.0.0.

NXString	OperatorMessage ()
	Returns the Operator Message String Created in NX6.0.0.

bool	OutputOperatorMessage ()
	Returns the output operator message option Created in NX6.0.0.

bool	OutputOpskip ()
	Returns the output opskip option Created in NX6.0.0.

bool	OutputOpstop ()
	Returns the output opstop option Created in NX6.0.0.

bool	OutputStop ()
	Returns the output stop option Created in NX6.0.0.

NXOpen::Point *	Point ()
	Returns the local return point Created in NX6.0.0.

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ReturnMoveModeTypes	ReturnMoveMode ()
	Returns the adjustment mode mode Created in NX6.0.0.

void	SetAdjustmentMode (NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::AdjustmentModeTypes adjustmentMode)
	Sets the adjustment mode mode Created in NX6.0.0.

void	SetDistance (double localDistanceValue)
	Sets the local distance value Created in NX6.0.0.

void	SetDwell (double dwell)
	Sets the Dwell Time or Revolutions Created in NX6.0.0.

void	SetDwellUnit (NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::DwellUnitTypes dwellUnit)
	Sets the Dwell Unit type Created in NX6.0.0.

void	SetLowerLimit (double lowerLimitValue)
	Sets the lower limit Created in NX6.0.0.

void	SetLowerLimitType (NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes lowerLimitModeValue)
	Set the lower limits mode Created in NX6.0.0.

void	SetMode (NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ModeTypes localReturnModeType)
	Sets the local return type Created in NX6.0.0.

void	SetNumberOfCuts (int localNumberOfCutsValue)
	Sets the local number of cuts Created in NX6.0.0.

void	SetNumberOfLevels (int localNumberOfLevelsValue)
	Sets the local number of levels Created in NX6.0.0.

void	SetNumberOfPasses (int localNumberOfPassesValue)
	Sets the local number of passes value Created in NX6.0.0.

void	SetOperatorMessage (const NXString &operatorMessage)
	Sets the Operator Message String Created in NX6.0.0.

void	SetOperatorMessage (const char *operatorMessage)
	Sets the Operator Message String Created in NX6.0.0.

void	SetOutputOperatorMessage (bool operatorMessage)
	Sets the output operator message option Created in NX6.0.0.

void	SetOutputOpskip (bool opskipValue)
	Sets the output opskip option Created in NX6.0.0.

void	SetOutputOpstop (bool opstopValue)
	Sets the output opstop option Created in NX6.0.0.

void	SetOutputStop (bool stopValue)
	Sets the output stop option Created in NX6.0.0.

void	SetPoint (NXOpen::Point *localReturnPoint)
	Sets the local return point Created in NX6.0.0.

void	SetReturnMoveMode (NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ReturnMoveModeTypes returnMoveMode)
	Sets the adjustment mode mode Created in NX6.0.0.

void	SetTime (double localTimeValue)
	Sets the local time value Created in NX6.0.0.

void	SetUpperLimit (double upperLimitValue)
	Sets the upper limit Created in NX6.0.0.

void	SetUpperLimitType (NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes upperLimitModeValue)
	Set the upper limits mode Created in NX6.0.0.

NXOpen::CAM::PostEventsCiBuilder *	StartOfPathBuilder ()
	Returns the start event builder Created in NX6.0.0.

double	Time ()
	Returns the local time value Created in NX6.0.0.

double	UpperLimit ()
	Returns the upper limit Created in NX6.0.0.

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 an avoidance start Builder
Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::AdjustmentModeTypes

the adjustment mode options
Created in NX6.0.0.

Enumerator:

AdjustmentModeTypesNone	Ajustment: None.
AdjustmentModeTypesRange	Ajustment: Range.
AdjustmentModeTypesAlignment	Ajustment: Alignment.

enum NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::DwellUnitTypes

the Dwell Unit type
Created in NX6.0.0.

Enumerator:

DwellUnitTypesNone	None.
DwellUnitTypesSeconds	Seconds.
DwellUnitTypesRevolutions	Revolutions.

enum NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes

the local limit mode
Created in NX6.0.0.

Enumerator:

LimitTypesDistanceOrTime	mm,inch or sec
LimitTypesPercent	%

enum NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ModeTypes

The local return type options
Created in NX6.0.0.

Enumerator:

ModeTypesNone	Local Return: None.
ModeTypesDistance	Local Return: Distance.
ModeTypesTime	Local Return: Time.
ModeTypesNumberOfPasses	Local Return: Number of Passes.
ModeTypesNumberOfCuts	Local Return: Number of Cuts.
ModeTypesNumberOfLevels	Local Return: Number of Levels.

enum NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ReturnMoveModeTypes

the return move mode options
Created in NX6.0.0.

Enumerator:

ReturnMoveModeTypesNone	Return Move: Nove.
ReturnMoveModeTypesDirect	Return Move: Direct.
ReturnMoveModeTypesRadialAxial	Return Move: Radial-Axial.
ReturnMoveModeTypesAxialRadial	Return Move: Axial-Radial.
ReturnMoveModeTypesClearRadialDirect	Return Move: Clear Radial-Direct.
ReturnMoveModeTypesClearAxialDirect	Return Move: Clear Axial-Direct.
ReturnMoveModeTypesClearRadial	Return Move: Clear Radial.
ReturnMoveModeTypesClearAxial	Return Move: Clear Axial.
ReturnMoveModeTypesRadialClearAxialDirect	Return Move: Radial-Clear Axial-Direct.
ReturnMoveModeTypesRadialAxialRadial	Return Move: Radial-Axial-Radial.
ReturnMoveModeTypesRadialClearAxial	Return Move: Radial-Clear Axial.
ReturnMoveModeTypesClearRadialClearAxialDirect	Return Move: Clear Radial-Clear Axial-Direct.
ReturnMoveModeTypesClearRadialAxialRadial	Return Move: Clear Radial-Axial-Radial.
ReturnMoveModeTypesClearRadialClearAxial	Return Move: Clear Radial-Clear Axial.
ReturnMoveModeTypesSameAsDeparture	Return Move: Same as Departure.

Member Function Documentation

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::AdjustmentModeTypes NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::AdjustmentMode ( )

Returns the adjustment mode mode
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::Distance ( )

Returns the local distance value
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::Dwell ( )

Returns the Dwell Time or Revolutions
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::DwellUnitTypes NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::DwellUnit ( )

Returns the Dwell Unit type
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::EndOfPathBuilder ( )

Returns the end event builder
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::GetLowerLimitType ( )

Get the lower limits mode.

Returns: the lower limits mode value
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::GetUpperLimitType ( )

Get the upper limits mode.

Returns: the upper limits mode value
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LowerLimit ( )

Returns the lower limit
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ModeTypes NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::Mode ( )

Returns the local return type
Created in NX6.0.0.

License requirements : None

int NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::NumberOfCuts ( )

Returns the local number of cuts
Created in NX6.0.0.

License requirements : None

int NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::NumberOfLevels ( )

Returns the local number of levels
Created in NX6.0.0.

License requirements : None

int NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::NumberOfPasses ( )

Returns the local number of passes value
Created in NX6.0.0.

License requirements : None

NXString NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::OperatorMessage ( )

Returns the Operator Message String
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::OutputOperatorMessage ( )

Returns the output operator message option
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::OutputOpskip ( )

Returns the output opskip option
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::OutputOpstop ( )

Returns the output opstop option
Created in NX6.0.0.

License requirements : None

bool NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::OutputStop ( )

Returns the output stop option
Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::Point ( )

Returns the local return point
Created in NX6.0.0.

License requirements : None

NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ReturnMoveModeTypes NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ReturnMoveMode ( )

Returns the adjustment mode mode
Created in NX6.0.0.

License requirements : None

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetAdjustmentMode ( NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::AdjustmentModeTypes adjustmentMode )

Sets the adjustment mode mode
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

adjustmentMode the adjustment mode value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetDistance ( double localDistanceValue )

Sets the local distance value
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localDistanceValue the local distance value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetDwell ( double dwell )

Sets the Dwell Time or Revolutions
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

dwell the Dwell Time or Revolutions value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetDwellUnit ( NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::DwellUnitTypes dwellUnit )

Sets the Dwell Unit type
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

dwellUnit the Dwell Unit value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetLowerLimit ( double lowerLimitValue )

Sets the lower limit
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

lowerLimitValue the lower limit value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetLowerLimitType ( NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes lowerLimitModeValue )

Set the lower limits mode
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

lowerLimitModeValue the lower limits mode value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetMode ( NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ModeTypes localReturnModeType )

Sets the local return type
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localReturnModeType the start local return type value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetNumberOfCuts ( int localNumberOfCutsValue )

Sets the local number of cuts
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localNumberOfCutsValue the local number of cuts value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetNumberOfLevels ( int localNumberOfLevelsValue )

Sets the local number of levels
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localNumberOfLevelsValue the local number of levels value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetNumberOfPasses ( int localNumberOfPassesValue )

Sets the local number of passes value
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localNumberOfPassesValue the local number of passes value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetOperatorMessage ( const NXString & operatorMessage )

Sets the Operator Message String
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

operatorMessage the Operator Message String value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetOperatorMessage ( const char * operatorMessage )

Sets the Operator Message String
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

operatorMessage the Operator Message String value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetOutputOperatorMessage ( bool operatorMessage )

Sets the output operator message option
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

operatorMessage the Operator Message value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetOutputOpskip ( bool opskipValue )

Sets the output opskip option
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

opskipValue the Opskip value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetOutputOpstop ( bool opstopValue )

Sets the output opstop option
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

opstopValue the Opstop value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetOutputStop ( bool stopValue )

Sets the output stop option
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

stopValue the Stop value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetPoint ( NXOpen::Point * localReturnPoint )

Sets the local return point
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localReturnPoint the local return point value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetReturnMoveMode ( NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::ReturnMoveModeTypes returnMoveMode )

Sets the adjustment mode mode
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

returnMoveMode the return move mode value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetTime ( double localTimeValue )

Sets the local time value
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

localTimeValue the local time value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetUpperLimit ( double upperLimitValue )

Sets the upper limit
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

upperLimitValue the upper limit value

void NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::SetUpperLimitType ( NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::LimitTypes upperLimitModeValue )

Set the upper limits mode
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

Parameters

upperLimitModeValue the upper limits mode value

NXOpen::CAM::PostEventsCiBuilder* NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::StartOfPathBuilder ( )

Returns the start event builder
Created in NX6.0.0.

License requirements : cam_base ("CAM BASE")

double NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::Time ( )

Returns the local time value
Created in NX6.0.0.

License requirements : None

double NXOpen::CAM::TurnRoughFinishLocalReturnBuilder::UpperLimit ( )

Returns the upper limit
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_TurnRoughFinishLocalReturnBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation