nxopen.cam

Interface TurnRoughFinishLocalReturnBuilder

All Superinterfaces:

Remote, TaggedObject

public interface TurnRoughFinishLocalReturnBuilder
extends TaggedObject

Represents an avoidance start Builder .
Created in NX6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TurnRoughFinishLocalReturnBuilder.AdjustmentModeTypes the adjustment mode options .
static class	TurnRoughFinishLocalReturnBuilder.DwellUnitTypes the Dwell Unit type .
static class	TurnRoughFinishLocalReturnBuilder.LimitTypes the local limit mode .
static class	TurnRoughFinishLocalReturnBuilder.ModeTypes The local return type options .
static class	TurnRoughFinishLocalReturnBuilder.ReturnMoveModeTypes the return move mode options .

Method Summary

Modifier and Type	Method and Description
TurnRoughFinishLocalReturnBuilder.AdjustmentModeTypes	adjustmentMode() Returns the adjustment mode mode License requirements: None.
double	distance() Returns the local distance value License requirements: None.
double	dwell() Returns the Dwell Time or Revolutions License requirements: None.
TurnRoughFinishLocalReturnBuilder.DwellUnitTypes	dwellUnit() Returns the Dwell Unit type License requirements: None.
PostEventsCiBuilder	endOfPathBuilder() Returns the end event builder License requirements: cam_base ("CAM BASE") .
TurnRoughFinishLocalReturnBuilder.LimitTypes	getLowerLimitType() Get the lower limits mode License requirements: None.
TurnRoughFinishLocalReturnBuilder.LimitTypes	getUpperLimitType() Get the upper limits mode License requirements: None.
double	lowerLimit() Returns the lower limit License requirements: None.
TurnRoughFinishLocalReturnBuilder.ModeTypes	mode() Returns the local return type License requirements: None.
int	numberOfCuts() Returns the local number of cuts License requirements: None.
int	numberOfLevels() Returns the local number of levels License requirements: None.
int	numberOfPasses() Returns the local number of passes value License requirements: None.
String	operatorMessage() Returns the Operator Message String License requirements: None.
boolean	outputOperatorMessage() Returns the output operator message option License requirements: None.
boolean	outputOpskip() Returns the output opskip option License requirements: None.
boolean	outputOpstop() Returns the output opstop option License requirements: None.
boolean	outputStop() Returns the output stop option License requirements: None.
Point	point() Returns the local return point License requirements: None.
TurnRoughFinishLocalReturnBuilder.ReturnMoveModeTypes	returnMoveMode() Returns the adjustment mode mode License requirements: None.
void	setAdjustmentMode(TurnRoughFinishLocalReturnBuilder.AdjustmentModeTypes adjustmentMode) License requirements: cam_base ("CAM BASE") .
void	setDistance(double localDistanceValue) License requirements: cam_base ("CAM BASE") .
void	setDwell(double dwell) License requirements: cam_base ("CAM BASE") .
void	setDwellUnit(TurnRoughFinishLocalReturnBuilder.DwellUnitTypes dwellUnit) License requirements: cam_base ("CAM BASE") .
void	setLowerLimit(double lowerLimitValue) License requirements: cam_base ("CAM BASE") .
void	setLowerLimitType(TurnRoughFinishLocalReturnBuilder.LimitTypes lowerLimitModeValue) Set the lower limits mode License requirements: cam_base ("CAM BASE") .
void	setMode(TurnRoughFinishLocalReturnBuilder.ModeTypes localReturnModeType) License requirements: cam_base ("CAM BASE") .
void	setNumberOfCuts(int localNumberOfCutsValue) License requirements: cam_base ("CAM BASE") .
void	setNumberOfLevels(int localNumberOfLevelsValue) License requirements: cam_base ("CAM BASE") .
void	setNumberOfPasses(int localNumberOfPassesValue) License requirements: cam_base ("CAM BASE") .
void	setOperatorMessage(String operatorMessage) License requirements: cam_base ("CAM BASE") .
void	setOutputOperatorMessage(boolean operatorMessage) License requirements: cam_base ("CAM BASE") .
void	setOutputOpskip(boolean opskipValue) License requirements: cam_base ("CAM BASE") .
void	setOutputOpstop(boolean opstopValue) License requirements: cam_base ("CAM BASE") .
void	setOutputStop(boolean stopValue) License requirements: cam_base ("CAM BASE") .
void	setPoint(Point localReturnPoint) License requirements: cam_base ("CAM BASE") .
void	setReturnMoveMode(TurnRoughFinishLocalReturnBuilder.ReturnMoveModeTypes returnMoveMode) License requirements: cam_base ("CAM BASE") .
void	setTime(double localTimeValue) License requirements: cam_base ("CAM BASE") .
void	setUpperLimit(double upperLimitValue) License requirements: cam_base ("CAM BASE") .
void	setUpperLimitType(TurnRoughFinishLocalReturnBuilder.LimitTypes upperLimitModeValue) Set the upper limits mode License requirements: cam_base ("CAM BASE") .
PostEventsCiBuilder	startOfPathBuilder() Returns the start event builder License requirements: cam_base ("CAM BASE") .
double	time() Returns the local time value License requirements: None.
double	upperLimit() Returns the upper limit License requirements: None.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Method Detail

mode

TurnRoughFinishLocalReturnBuilder.ModeTypes mode()
                                          throws NXException,
                                                 RemoteException

Returns the local return type
License requirements: None.

Created in NX6.0.0

Returns:

the start local return type value

Throws:

NXException

RemoteException

setMode

void setMode(TurnRoughFinishLocalReturnBuilder.ModeTypes localReturnModeType)
      throws NXException,
             RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localReturnModeType - the start local return type value

Throws:

NXException

RemoteException

distance

double distance()
         throws NXException,
                RemoteException

Returns the local distance value
License requirements: None.

Created in NX6.0.0

Returns:

the local distance value

Throws:

NXException

RemoteException

setDistance

void setDistance(double localDistanceValue)
          throws NXException,
                 RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localDistanceValue - the local distance value

Throws:

NXException

RemoteException

time

double time()
     throws NXException,
            RemoteException

Returns the local time value
License requirements: None.

Created in NX6.0.0

Returns:

the local time value

Throws:

NXException

RemoteException

setTime

void setTime(double localTimeValue)
      throws NXException,
             RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localTimeValue - the local time value

Throws:

NXException

RemoteException

numberOfPasses

int numberOfPasses()
            throws NXException,
                   RemoteException

Returns the local number of passes value
License requirements: None.

Created in NX6.0.0

Returns:

the local number of passes value

Throws:

NXException

RemoteException

setNumberOfPasses

void setNumberOfPasses(int localNumberOfPassesValue)
                throws NXException,
                       RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localNumberOfPassesValue - the local number of passes value

Throws:

NXException

RemoteException

adjustmentMode

TurnRoughFinishLocalReturnBuilder.AdjustmentModeTypes adjustmentMode()
                                                              throws NXException,
                                                                     RemoteException

Returns the adjustment mode mode
License requirements: None.

Created in NX6.0.0

Returns:

the adjustment mode value

Throws:

NXException

RemoteException

setAdjustmentMode

void setAdjustmentMode(TurnRoughFinishLocalReturnBuilder.AdjustmentModeTypes adjustmentMode)
                throws NXException,
                       RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

adjustmentMode - the adjustment mode value

Throws:

NXException

RemoteException

returnMoveMode

TurnRoughFinishLocalReturnBuilder.ReturnMoveModeTypes returnMoveMode()
                                                              throws NXException,
                                                                     RemoteException

Returns the adjustment mode mode
License requirements: None.

Created in NX6.0.0

Returns:

the return move mode value

Throws:

NXException

RemoteException

setReturnMoveMode

void setReturnMoveMode(TurnRoughFinishLocalReturnBuilder.ReturnMoveModeTypes returnMoveMode)
                throws NXException,
                       RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

returnMoveMode - the return move mode value

Throws:

NXException

RemoteException

point

Point point()
     throws NXException,
            RemoteException

Returns the local return point
License requirements: None.

Created in NX6.0.0

Returns:

the local return point value

Throws:

NXException

RemoteException

setPoint

void setPoint(Point localReturnPoint)
       throws NXException,
              RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localReturnPoint - the local return point value

Throws:

NXException

RemoteException

lowerLimit

double lowerLimit()
           throws NXException,
                  RemoteException

Returns the lower limit
License requirements: None.

Created in NX6.0.0

Returns:

the lower limit value

Throws:

NXException

RemoteException

setLowerLimit

void setLowerLimit(double lowerLimitValue)
            throws NXException,
                   RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

lowerLimitValue - the lower limit value

Throws:

NXException

RemoteException

getLowerLimitType

TurnRoughFinishLocalReturnBuilder.LimitTypes getLowerLimitType()
                                                        throws NXException,
                                                               RemoteException

Get the lower limits mode
License requirements: None.

Created in NX6.0.0

Returns:

the lower limits mode value

Throws:

NXException

RemoteException

setLowerLimitType

void setLowerLimitType(TurnRoughFinishLocalReturnBuilder.LimitTypes lowerLimitModeValue)
                throws NXException,
                       RemoteException

Set the lower limits mode
License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

lowerLimitModeValue - the lower limits mode value

Throws:

NXException

RemoteException

upperLimit

double upperLimit()
           throws NXException,
                  RemoteException

Returns the upper limit
License requirements: None.

Created in NX6.0.0

Returns:

the upper limit value

Throws:

NXException

RemoteException

setUpperLimit

void setUpperLimit(double upperLimitValue)
            throws NXException,
                   RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

upperLimitValue - the upper limit value

Throws:

NXException

RemoteException

getUpperLimitType

TurnRoughFinishLocalReturnBuilder.LimitTypes getUpperLimitType()
                                                        throws NXException,
                                                               RemoteException

Get the upper limits mode
License requirements: None.

Created in NX6.0.0

Returns:

the upper limits mode value

Throws:

NXException

RemoteException

setUpperLimitType

void setUpperLimitType(TurnRoughFinishLocalReturnBuilder.LimitTypes upperLimitModeValue)
                throws NXException,
                       RemoteException

Set the upper limits mode
License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

upperLimitModeValue - the upper limits mode value

Throws:

NXException

RemoteException

outputStop

boolean outputStop()
            throws NXException,
                   RemoteException

Returns the output stop option
License requirements: None.

Created in NX6.0.0

Returns:

the Stop value

Throws:

NXException

RemoteException

setOutputStop

void setOutputStop(boolean stopValue)
            throws NXException,
                   RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

stopValue - the Stop value

Throws:

NXException

RemoteException

outputOpstop

boolean outputOpstop()
              throws NXException,
                     RemoteException

Returns the output opstop option
License requirements: None.

Created in NX6.0.0

Returns:

the Opstop value

Throws:

NXException

RemoteException

setOutputOpstop

void setOutputOpstop(boolean opstopValue)
              throws NXException,
                     RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

opstopValue - the Opstop value

Throws:

NXException

RemoteException

outputOpskip

boolean outputOpskip()
              throws NXException,
                     RemoteException

Returns the output opskip option
License requirements: None.

Created in NX6.0.0

Returns:

the Opskip value

Throws:

NXException

RemoteException

setOutputOpskip

void setOutputOpskip(boolean opskipValue)
              throws NXException,
                     RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

opskipValue - the Opskip value

Throws:

NXException

RemoteException

outputOperatorMessage

boolean outputOperatorMessage()
                       throws NXException,
                              RemoteException

Returns the output operator message option
License requirements: None.

Created in NX6.0.0

Returns:

the Operator Message value

Throws:

NXException

RemoteException

setOutputOperatorMessage

void setOutputOperatorMessage(boolean operatorMessage)
                       throws NXException,
                              RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

operatorMessage - the Operator Message value

Throws:

NXException

RemoteException

operatorMessage

String operatorMessage()
                throws NXException,
                       RemoteException

Returns the Operator Message String
License requirements: None.

Created in NX6.0.0

Returns:

the Operator Message String value

Throws:

NXException

RemoteException

setOperatorMessage

void setOperatorMessage(String operatorMessage)
                 throws NXException,
                        RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

operatorMessage - the Operator Message String value

Throws:

NXException

RemoteException

dwellUnit

TurnRoughFinishLocalReturnBuilder.DwellUnitTypes dwellUnit()
                                                    throws NXException,
                                                           RemoteException

Returns the Dwell Unit type
License requirements: None.

Created in NX6.0.0

Returns:

the Dwell Unit value

Throws:

NXException

RemoteException

setDwellUnit

void setDwellUnit(TurnRoughFinishLocalReturnBuilder.DwellUnitTypes dwellUnit)
           throws NXException,
                  RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

dwellUnit - the Dwell Unit value

Throws:

NXException

RemoteException

dwell

double dwell()
      throws NXException,
             RemoteException

Returns the Dwell Time or Revolutions
License requirements: None.

Created in NX6.0.0

Returns:

the Dwell Time or Revolutions value

Throws:

NXException

RemoteException

setDwell

void setDwell(double dwell)
       throws NXException,
              RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

dwell - the Dwell Time or Revolutions value

Throws:

NXException

RemoteException

startOfPathBuilder

PostEventsCiBuilder startOfPathBuilder()
                                throws NXException,
                                       RemoteException

Returns the start event builder
License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Returns:

the start of path builder

Throws:

NXException

RemoteException

endOfPathBuilder

PostEventsCiBuilder endOfPathBuilder()
                              throws NXException,
                                     RemoteException

Returns the end event builder
License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Returns:

the end of path builder

Throws:

NXException

RemoteException

numberOfCuts

int numberOfCuts()
          throws NXException,
                 RemoteException

Returns the local number of cuts
License requirements: None.

Created in NX6.0.0

Returns:

the local number of cuts value

Throws:

NXException

RemoteException

setNumberOfCuts

void setNumberOfCuts(int localNumberOfCutsValue)
              throws NXException,
                     RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localNumberOfCutsValue - the local number of cuts value

Throws:

NXException

RemoteException

numberOfLevels

int numberOfLevels()
            throws NXException,
                   RemoteException

Returns the local number of levels
License requirements: None.

Created in NX6.0.0

Returns:

the local number of levels value

Throws:

NXException

RemoteException

setNumberOfLevels

void setNumberOfLevels(int localNumberOfLevelsValue)
                throws NXException,
                       RemoteException

License requirements: cam_base ("CAM BASE")
.
Created in NX6.0.0

Parameters:

localNumberOfLevelsValue - the local number of levels value

Throws:

NXException

RemoteException