NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::TurnRoughFinishLocalReturnBuilder Class Reference

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

Inheritance diagram for NXOpen::CAM::TurnRoughFinishLocalReturnBuilder:
NXOpen::TaggedObject

List of all members.

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
}
 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::PostEventsCiBuilderEndOfPathBuilder ()
 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::PointPoint ()
 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 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::PostEventsCiBuilderStartOfPathBuilder ()
 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.

Detailed Description

Represents an avoidance start Builder
Created in NX6.0.0.



Member Enumeration Documentation

the adjustment mode options
Created in NX6.0.0.


Enumerator:
AdjustmentModeTypesNone 

Ajustment: None.

AdjustmentModeTypesRange 

Ajustment: Range.

AdjustmentModeTypesAlignment 

Ajustment: Alignment.

the Dwell Unit type
Created in NX6.0.0.


Enumerator:
DwellUnitTypesNone 

None.

DwellUnitTypesSeconds 

Seconds.

DwellUnitTypesRevolutions 

Revolutions.

the local limit mode
Created in NX6.0.0.


Enumerator:
LimitTypesDistanceOrTime 

mm,inch or sec

LimitTypesPercent 

%

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.

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.


Member Function Documentation

Returns the adjustment mode mode
Created in NX6.0.0.



License requirements : None

Returns the local distance value
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the Dwell Unit type
Created in NX6.0.0.



License requirements : None

Returns the end event builder
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Get the lower limits mode.

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

License requirements : None

Get the upper limits mode.

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

License requirements : None

Returns the lower limit
Created in NX6.0.0.



License requirements : None

Returns the local return type
Created in NX6.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the Operator Message String
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the output opskip option
Created in NX6.0.0.



License requirements : None

Returns the output opstop option
Created in NX6.0.0.



License requirements : None

Returns the output stop option
Created in NX6.0.0.



License requirements : None

Returns the local return point
Created in NX6.0.0.



License requirements : None

Returns the adjustment mode mode
Created in NX6.0.0.



License requirements : None

Sets the adjustment mode mode
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
adjustmentModethe adjustment mode value

Sets the local distance value
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
localDistanceValuethe local distance value

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



License requirements : cam_base ("CAM BASE")

Parameters:
dwellthe Dwell Time or Revolutions value

Sets the Dwell Unit type
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
dwellUnitthe Dwell Unit value

Sets the lower limit
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
lowerLimitValuethe lower limit value

Set the lower limits mode
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
lowerLimitModeValuethe lower limits mode value

Sets the local return type
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
localReturnModeTypethe start local return type value

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



License requirements : cam_base ("CAM BASE")

Parameters:
localNumberOfCutsValuethe local number of cuts value

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



License requirements : cam_base ("CAM BASE")

Parameters:
localNumberOfLevelsValuethe local number of levels value

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



License requirements : cam_base ("CAM BASE")

Parameters:
localNumberOfPassesValuethe local number of passes value

Sets the Operator Message String
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
operatorMessagethe Operator Message String value

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



License requirements : cam_base ("CAM BASE")

Parameters:
operatorMessagethe Operator Message value

Sets the output opskip option
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
opskipValuethe Opskip value

Sets the output opstop option
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
opstopValuethe Opstop value

Sets the output stop option
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
stopValuethe Stop value

Sets the local return point
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
localReturnPointthe local return point value

Sets the adjustment mode mode
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
returnMoveModethe return move mode value

Sets the local time value
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
localTimeValuethe local time value

Sets the upper limit
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
upperLimitValuethe upper limit value

Set the upper limits mode
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Parameters:
upperLimitModeValuethe upper limits mode value

Returns the start event builder
Created in NX6.0.0.



License requirements : cam_base ("CAM BASE")

Returns the local time value
Created in NX6.0.0.



License requirements : None

Returns the upper limit
Created in NX6.0.0.



License requirements : None


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