Lathe Scripting Function Reference

Function:

double LATHE_SetXRapid(double var)

Description:

Sets the current rapid location for the X Axis using a Double variable.

Usage:

LATHE_SetXRapid(variable_name)

Function:

double LATHE_GetXRapid()

Description:

Returns the current rapid location for the X Axis.

Usage:

variable_name = LATHE_GetXRapid()

Function:

void LATHE_SetZRapid(double var)

Description:

Sets the current rapid location for the Z Axis using a Double variable.

Usage:

LATHE_SetZRapid(variable_name)

Function:

double LATHE_GetZRapid()

Description:

Returns the current rapid location for the Z Axis.

Usage:

variable_name = LATHE_GetZRapid()

Function:

void LATHE_SetPreviousXFeed(double var)

Description:

Sets the previous feed location for the X Axis using a Double variable.

Usage:

LATHE_SetPreviousXFeed(variable_name)

Function:

double LATHE_GetPreviousXFeed()

Description:

Returns the previous feed location for the X Axis.

Usage:

variable_name = LATHE_GetPreviousXFeed()

Function:

void LATHE_SetPreviousZFeed(double var)

Description:

Sets the previous feed location for the Z Axis using a Double variable.

Usage:

LATHE_SetPreviousZFeed(variable_name)

Function:

double LATHE_GetFinishFeedRate()

Description:

Returns the current Finish feed rate

Usage:

variable_name = LATHE_GetFinishFeedRate()

Function:

double LATHE_GetPreviousZFeed()

Description:

Returns the previous feed location for the Z Axis.

Usage:

variable_name = LATHE_GetPreviousZFeed()

Function:

double LATHE_GetFeedRate()

Description:

Returns the current feedrate

Usage:

variable_name = LATHE_GetFeedRate()

Function:

double LATHE_GetArcCenterZ()

Description:

Returns the Z-axis location of the current arc center.

Usage:

variable_name = LATHE_GetArcCenterZ()

Function:

double LATHE_GetArcCenterX()

Description:

Returns the X-axis location of the current arc center.

Usage:

variable_name = LATHE_GetArcCenterX()

Function:

void LATHE_SetStockPosZ(double var)

Description:

Sets the Z axis stock position.

Usage:

LATHE_SetStockPosZ(variable_name)

Function:

double LATHE_GetStockPosZ()

Description:

Returns the Z axis stock position.

Usage:

variable_name = LATHE_GetStockPosZ()

Function:

void LATHE_SetStockPosX(double var)

Description:

Sets the X axis stock position.

Usage:

LATHE_SetStockPosX(variable_name)

Function:

double LATHE_GetStockPosX()

Description:

Returns the X axis stock position.

Usage:

variable_name = LATHE_GetStockPosX()

Function:

void LATHE_SetStockFeedToZ(double var)

Description:

Sets the stock feed to Z value

Usage:

LATHE_SetStockFeedToZ(variable_name)

Function:

double LATHE_GetStockFeedToZ()

Description:

Returns the Z axis stock feed to position.

Usage:

variable_name = LATHE_GetStockFeedToZ()

Function:

double LATHE_GetStockLength()

Description:

Returns the length of the currently defined stock.

Usage:

variable_name = LATHE_GetStockLength()

Function:

double LATHE_GetStockInternalDiameter()

Description:

Returns the internal diameter of the currently defined stock.

Usage:

variable_name = LATHE_GetStockInternalDiameter()

Function:

double LATHE_GetStockFaceZLocation()

Description:

Returns the Z axis position of the stock face.

Usage:

variable_name = LATHE_GetStockFaceZLocation()

Function:

double LATHE_GetStockEndZLocation()

Description:

Returns the Z axis position of the end of the stock.

Usage:

variable_name = LATHE_GetStockEndZLocation()

Function:

short LATHE_GetStockDiameter()

Description:

Returns a value indicating if this current operation is a roughing operation or not.

0 = Not Finish

1 = Is Finish

Usage:

variable_name = LATHE_GetIsFinish()

Function:

short LATHE_GetUnits()

Description:

Returns the current unit setting

0 = Inch

1 = Metric

Usage:

variable_name = LATHE_GetUnits()

Function:

short LATHE_GetCurrentLineNumber()

Description:

Returns the current line number

Usage:

variable_name = LATHE_GetCurrentLineNumber()

Function:

short LATHE_GetLineNumberIncrement()

Description:

Returns the current line number increment value

Usage:

variable_name = LATHE_GetLineNumberIncrement()

Function:

short LATHE_GetLineNumberFirstFinish()

Description:

Returns the P word for the first line number of turning canned cycle output to finish pass.

Usage:

variable_name = LATHE_GetLineNumberFirstFinish()

Function:

short LATHE_GetLineNumberLastFinish()

Description:

Returns the Q word for the last line number of turning canned cycle output to finish pass.

Usage:

variable_name = LATHE_GetLineNumberLastFinish()

Function:

short LATHE_GetProgramNumber()

Description:

Returns the program number of the current program.

Usage:

variable_name = LATHE_GetProgramNumber()

Function:

string  LATHE_GetProgramName()

Description:

Returns the path and name of the current program.

Usage:

variable_name = LATHE_GetProgramName()

Function:

string LATHE_GetLastFinishLineNumberPrefix()

Description:

This returns the prefix string for the last line of a finish canned cycle. The prefix string is defined on post question #791.

Usage:

variable_name = LATHE_GetLastFinishLineNumberPrefix()

Function:

string LATHE_GetFirstRoughLineNumberPrefix()

Description:

This returns the prefix string for the first line of a Rough canned cycle. The prefix string is defined on post question #790.

Usage:

variable_name = LATHE_GetFirstRoughLineNumberPrefix()

Function:

string LATHE_GetLastRoughLineNumberPrefix()

Description:

This returns the prefix string for the last line of a Rough canned cycle. The prefix string is defined on post question #790.

Usage:

variable_name = LATHE_GetLastRoughLineNumberPrefix()

Function:

short LATHE_GetCycleType()

Description:

Returns a value that identifies the feature type.

1 - Turning Rough
2 - Turning Rough / Finish
3 - Face Rough
4 - Face Rough / Finish

Usage:

variable_name = LATHE_GetCycleType()

Function:

void LATHE_SetReturnString(string var)

Description:

For the case that the block outputs code within an existing posting line, meaning the program block is being used to output for a single variable.

(for example, n, rapid_move, program_block_1, xr, yr)

Sets the return string to be output by the program block variable.

Usage:

LATHE_SetReturnString(variable_name)

Function:

void LATHE_OutputText(string var)

Description:

Outputs a string into the posted program with a line feed character.

Usage:

LATHE_OutputText(variable_name)

LATHE_OutputText(“Sample String”)

Function:

void LATHE_ProcessPostLine(string var)

Description:

Input must be a string formatted exactly as a posting line using system posting variables (for example, “n,rapid_move,xr,yr,’M08’”). The system post processes these variables as it would by using the posting engine and output the posted string to the posted NC file.

Usage:

LATHE_ProcessPostLine(variable_name)

Example:

LATHE_ProcessPostLine(“n,rapid_move,xr,yr,’M08’”)

Function:

string LATHE_GetOutputLineToNcFile()

Description:

Returns a single line of the posted code to a string variable. This is used in program block 2102, and block 540 must be set to Y. This allows you to modify the code after it has been processed through the posting engine.

Usage:

variable_name = LATHE_GetOutputLineToNcFile()

Function:

void LATHE_SetOutputLineToNcFile(string var)

Description:

Sets the string to be output in the posted program followed by a carriage return/line feed.

Usage:

LATHE_SetOutputLineToNcFile(var)

Function:

string LATHE_GetDate()

Description:

Returns the day and date

Usage:

variable_name = LATHE_GetDate()

Function:

void LATHE_SetIntMemoryLoc(short Index, short SetInteger)

Description:

Sets the memory location at the specified index to the value specified for SetInteger.

Usage:

LATHE_SetIntMemoryLoc(Index, SetInteger)

Function:

void LATHE_SetDoubleMemoryLoc(short Index, short SetDouble)

Description:

Sets the memory location at the specified index to the value specified for SetDouble.

Usage:

LATHE_SetDoubleMemoryLoc(Index, SetDouble)

Function:

void LATHE_SetStringMemoryLoc(short Index, short SetString)

Description:

Sets the memory location at the specified index to the value specified for SetString.

Usage:

LATHE_SetStringMemoryLoc(Index, SetString)

Function:

short LATHE_GetIntMemoryLoc(short index)

Description:

Returns the integer value stored in the specified index.

Usage:

variable_name = LATHE_GetIntMemoryLoc(short index)

Function:

double LATHE_GetDoubleMemoryLoc(short index)

Description:

Returns the double value stored in the specified index.

Usage:

variable_name = LATHE_GetDoubleMemoryLoc(short index)

Function:

string LATHE_GetStringMemoryLoc(short index)

Description:

Returns the string value stored in the specified index.

Usage:

variable_name = LATHE_GetStringMemoryLoc(short index)

Function:

void LATHE_SetXHome(double var)

Description:

Sets the X Home Position

Usage:

LATHE_SetXHome()

Function:

double LATHE_GetXHome(double var)

Description:

Returns the X Home Position

Usage:

variable_name = LATHE_GetXHome()

Function:

void LATHE_SetZHome(double var)

Description:

Sets the Z Home Position

Usage:

LATHE_SetZHome()

Function:

double LATHE_GetZHome(double var)

Description:

Returns the Z Home Position

Usage:

variable_name = LATHE_GetZHome()

Function:

void LATHE_SetPickupZ(double var)

Description:

Sets the Z axis pickup value.

Usage:

LATHE_SetPickupZ(variable_name)

Function:

double LATHE_GetPickupZ()

Description:

Returns the Z axis pickup value.

Usage:

variable_name = LATHE_GetPickupZ()

Function:

string LATHE_GetFirstFinishLineNumberPrefix()

Description:

This returns the prefix string for the first line of a finish canned cycle. The prefix string is defined on post question #790.

Usage:

variable_name = LATHE_GetFirstFinishLineNumberPrefix()

Function:

double LATHE_GetPosRpm()

Description:

Get the value of the pos_rpm variable.

Usage:

variable_name = LATHE_GetPosRpm()

Function:

double LATHE_GetPrevPosRpm()

Description:

Get previous value of the pos_rpm variable.

Usage:

variable_name = LATHE_GetPrevPosRpm()

Function:

string LATHE_GetComment1()

Description:

Returns the comment1 post variable.

Usage:

variable_name = LATHE_GetComment1()

Function:

string LATHE_GetComment2()

Description:

Returns the comment2 post variable.

Usage:

variable_name = LATHE_GetComment2()

Function:

string LATHE_GetComment3()

Description:

Returns the comment3 post variable.

Usage:

variable_name = LATHE_GetComment3()

Function:

short LATHE_GetToolOrientation()

Description:

Returns the current tool orientation (number 1-8).

Usage:

variable_name = LATHE_GetToolOrientation()

Function:

short LATHE_GetToolNumber()

Description:

Returns the current tool number

Usage:

variable_name = LATHE_GetToolNumber()

Function:

short LATHE_GetFinishToolNumber()

Description:

Returns the number of the finishing tool.

Usage:

variable_name = LATHE_GetFinishToolNumber()

Function:

short LATHE_GetToolNumberT1()

Description:

Returns the number of the T1 tool.  This is used with question #260 in the post. Question #260 adds the set number to the current tool.

Usage:

variable_name = LATHE_GetToolNumberT1()

Function:

short LATHE_GetToolNumberT2()

Description:

Returns the number of the T2 tool.  This is used with question #261 in the post. Question #261 adds the set number to the current tool.

Usage:

variable_name = LATHE_GetToolNumberT2()

Function:

short LATHE_GetSpecialToolNumber()

Description:

Returns the special formatted tool number based on question #512 settings.

1 = number

2 = number * 101

3 = 100 * number + offset

4 = tool offset

5 = number * 100

Usage:

variable_name = LATHE_GetSpecialToolNumber()

Function:

short LATHE_GetFinishSpecialToolNumber()

Description:

Returns the special formatted tool number based on question #512 settings.

1 = number

2 = number * 101

3 = 100 * number + offset

4 = tool offset

5 = number * 100

Usage:

variable_name = LATHE_GetFinishSpecialToolNumber()

Function:

short LATHE_GetLineNumberWithToolNumber()

Description:

Returns the tool number based on this formula:

Tool Number * 100 + Sequence Number Increment

Usage:

variable_name = LATHE_GetLineNumberWithToolNumber()

Function:

short LATHE_GetLineNumberWithFinishToolNumber()

Description:

Returns the tool number based on this formula:

Tool Number * 100 + Sequence Number Increment

Usage:

variable_name = LATHE_GetLineNumberWithFinishToolNumber()

Function:

short LATHE_GetFirstToolNumber()

Description:

Returns the first tool number.

Usage:

variable_name = LATHE_GetFirstToolNumber()

Function:

short LATHE_GetNextToolNumber()

Description:

Returns the next tool number.

Usage:

variable_name = LATHE_GetNextToolNumber()

Function:

short LATHE_GetIsCoolantOn()

Description:

Returns the current coolant state

Usage:

variable_name = LATHE_GetIsCoolantOn()

Function:

string LATHE_GetCoolantOn()

Description:

Returns the coolant on string

Usage:

variable_name = LATHE_GetCoolantOn()

Function:

string LATHE_GetCoolantOff()

Description:

Returns the coolant off string

Usage:

variable_name = LATHE_GetCoolantOff()

Function:

string LATHE_GetSpindleOn()

Description:

Returns the spindle on code based on the currently defined spindle direction.

Usage:

variable_name = LATHE_GetSpindleOn()

Function:

string LATHE_GetSpindleOff()

Description:

Returns the spindle off code.

Usage:

variable_name = LATHE_GetSpindleOff()

Function:

short LATHE_GetFinishSpindleSpeed()

Description:

Returns the spindle speed of the finish operation.

Usage:

variable_name = LATHE_GetFinishSpindleSpeed()

Function:

short LATHE_GetMaximumSpindleSpeed()

Description:

Returns the maximum spindle speed for the current operation.

Usage:

variable_name = LATHE_GetMaximumSpindleSpeed()

Function:

string LATHE_GetSpindleSpeedCode()

Description:

Returns the codes defined for CSS and RPM on post question numbers

#785 – CSS code

#786 – RPM code

Usage:

variable_name = LATHE_GetSpindleSpeedCode()

Function:

string LATHE_GetFinishSpindleSpeedCode()

Description:

Returns the codes defined for CSS and RPM on post question numbers

#785 – CSS code

#786 – RPM code

Usage:

variable_name = LATHE_GetFinishSpindleSpeedCode()

Function:

short LATHE_GetCssRpm()

Description:

Returns the current CSS or RPM value for the feature.

Usage:

variable_name = LATHE_GetCssRpm()

Function:

string LATHE_GetSpindleGear()

Description:

Returns the code selected for the current gear range.  The gear range is determined by Questions #517-#526.  The code that is returned is defined in Questions #830-#839.

Usage:

variable_name = LATHE_GetSpindleGear()

Function:

short LATHE_GetFinishCssRpm()

Description:

Returns the current CSS or RPM value for the Finish pass.

Usage:

variable_name = LATHE_GetFinishCssRpm()

Function:

short LATHE_GetCutterCompSide()

Description:

Returns the side for machine comp on current feature

0 = None

41 = Left

42 = Right

Usage:

variable_name = LATHE_GetCutterCompSide()

Function:

short LATHE_GetLengthOffsetNumber()

Description:

Returns the current length offset number

Usage:

variable_name = LATHE_GetLengthOffsetNumber()

Function:

short LATHE_GetFeatureType()

Return Values:

Description:

Returns the current operation type.

Usage:

variable_name = LATHE_GetFeatureType()

Function:

double LATHE_GetRoughXAllowance()

Description:

This returns the X allowance value defined in the rough canned cycle feature parameters.

Usage:

variable_name = LATHE_GetRoughXAllowance()

Function:

double LATHE_GetRoughZAllowance()

Description:

This returns the Z allowance value defined in the rough canned cycle feature parameters.

Usage:

variable_name = LATHE_GetRoughZAllowance()

Function:

double LATHE_GetRoughDepthOfCut()

Description:

This returns the depth of cut value defined in the rough canned cycle feature parameters.

Usage:

variable_name = LATHE_GetRoughDepthOfCut()

Function:

double LATHE_GetRoughFeedRate()

Description:

This returns the feedrate value defined in the rough canned cycle feature parameters.

Usage:

variable_name = LATHE_GetRoughFeedRate()

Function:

double LATHE_GetRoughRetractAmount()

Description:

This returns the retract amount value defined by post question #411.  

Usage:

variable_name = LATHE_GetRoughRetractAmount()

Function:

short LATHE_GetIsRough()

Description:

Returns a value indicating if this current operation is a roughing operation or not.

0 = Not Rough

1 = Is Rough

Usage:

variable_name = LATHE_GetIsRough()

Function:

double LATHE_GetFinishXSpringPassStockDiameter()

Description:

This returns the X Stock value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetFinishXSpringPassStockDiameter()

Function:

double LATHE_GetFinishZSpringPassStockDiameter()

Description:

This returns the Z Stock value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetFinishZSpringPassStockDiameter()

Function:

double LATHE_GetFinishXSpringPassStockRadius()

Description:

This returns the radius of the X Stock value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetFinishXSpringPassStockRadius()

Function:

double LATHE_GetFinishZSpringPassStockRadius()

Description:

This returns the radius of the Z Stock value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetFinishZSpringPassStockRadius()

Function:

double LATHE_GetXFinishAllowance()

Description:

This returns the X allowance value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetXFinishAllowance()

Function:

double LATHE_GetZFinishAllowance()

Description:

This returns the Z allowance value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetZFinishAllowance()

Function:

short LATHE_GetFinishNumberOfCuts()

Description:

This returns the number of passes value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetFinishNumberOfCuts()

Function:

short LATHE_GetFinishNumberOfCutsTwoLine()

Description:

This returns the number of passes value defined in the finish feature parameters.

Usage:

variable_name = LATHE_GetFinishNumberOfCutsTwoLine()

Function:

short LATHE_GetIsFinish()

Description:

Returns a value indicating if this current operation is a finish operation or not.

0 = Not Finish

1 = Is Finish

Usage:

variable_name = LATHE_GetIsFinish()

Function:

double LATHE_GetGrooveXBottom()

Description:

This returns the X axis bottom coordinate from a canned grooving cycle. 

Usage:

variable_name = LATHE_GetGrooveXBottom()

Function:

double LATHE_GetGrooveZBottom()

Description:

This returns the Z axis bottom coordinate from a canned grooving cycle. 

Usage:

variable_name = LATHE_GetGrooveZBottom()

Function:

double LATHE_GetGrooveCycleRetract()

Description:

Returns the value for the groove cycle retract.  This value is set in post question #412.

Usage:

variable_name = LATHE_GetGrooveCycleRetract()

Function:

double LATHE_GetGroovePeckIncrement()

Description:

This returns the peck increment value defined in the groove feature parameters UI pages.   

Usage:

variable_name = LATHE_GetGroovePeckIncrement()

Function:

double LATHE_GetGrooveDepthOfCut()

Description:

This returns the step over value defined in the groove feature parameters UI pages.   

Usage:

variable_name = LATHE_GetGrooveDepthOfCut()

Function:

short LATHE_GetDrillDwell()

Description:

This returns the dwell value defined in the lathe drill feature parameters UI pages.   

Usage:

variable_name = LATHE_GetDrillDwell()

Function:

double LATHE_GetFirstPeck()

Description:

This returns the first peck amount value defined in the lathe drill feature parameters UI pages.   

Usage:

variable_name = LATHE_GetFirstPeck()

Function:

double LATHE_GetPeckIncrement()

Description:

This returns the peck increment amount value defined in the lathe drill feature parameters UI pages.   

Usage:

variable_name = LATHE_GetPeckIncrement()

Function:

double LATHE_GetPeckClearance()

Description:

This returns the peck clearance amount value defined in the lathe drill feature parameters UI pages.   

Usage:

variable_name = LATHE_GetPeckClearance()

Function:

double LATHE_GetPeckRetract()

Description:

This returns the peck retract amount value defined in the lathe drill feature parameters UI pages.   

Usage:

variable_name = LATHE_GetPeckRetract()

Function:

short LATHE_GetTapThreadDirection(short index)

Description:

Returns a value identifying the tap thread direction.

0 = RH

1 = LH

Usage:

variable_name = LATHE_GetTapThreadDirection(short index)

Function:

double LATHE_GetTapG32FinalZ()

Description:

Returns the Z axis Final Z position for a G32 Tapping cycle

Usage:

variable_name = LATHE_GetTapG32FinalZ()

Function:

double LATHE_GetTapG32InitalZ()

Description:

Returns the Z axis Initial Z position for a G32 Tapping cycle

Usage:

variable_name = LATHE_GetTapG32InitialZ()

Function:

double LATHE_GetTapCannedFinalZ()

Description:

Returns the Z axis Final Z position for a Canned Tapping cycle

Usage:

variable_name = LATHE_GetTapG32FinalZ()

Function:

double LATHE_GetTapCannedX()

Description:

Returns the X axis position for a Canned Tapping cycle

Usage:

variable_name = LATHE_GetTapCannedX()

Function:

double LATHE_GetTapFeed()

Description:

Returns the programmed feedrate for the tapping cycle

Usage:

variable_name = LATHE_GetTapFeed()

Function:

short LATHE_GetTapFeedMode()

Description:

Returns the feed mode for the tapping cycle defined by post question #305.

0 = Unit Per Minute

1 = Unit Per Revolution

Usage:

variable_name = LATHE_GetTapFeedMode()

Function:

short LATHE_SetTapFeedMode(Short FeedMode)

Description:

Sets the feed mode for the tapping cycle.  Post question #305. is the default setting for the tap mode.

0 = Unit Per Minute

1 = Unit Per Revolution

Usage:

variable_name = LATHE_SetTapFeedMode(short FeedMode)

Function:

double LATHE_GetThreadX2()

Description:

This returns the thread final X diameter of the threading cycle.   

Usage:

variable_name = LATHE_GetThreadX2()

Function:

double LATHE_GetThreadZ2()

Description:

This returns the thread final Z diameter of the threading cycle.   

Usage:

variable_name = LATHE_GetThreadZ2()

Function:

short LATHE_GetUseThreadAngleOut()

Description:

This return value is based on the setting for the Canned Cycle Chamfer Cut option in the feature UI pages.

0 = Off

1 = On    

Usage:

variable_name = LATHE_GetUseThreadAngleOut()

Function:

short LATHE_GetThreadHeight()

Description:

This returns the value for the thread height set in the feature UI pages.

Usage:

variable_name = LATHE_GetThreadHeight()

Function:

double LATHE_GetTaperHeight()

Description:

Returns the value for the height of the thread taper (positive = ID, negative = OD).

Usage:

variable_name = LATHE_GetTaperHeight()

Function:

double LATHE_GetThreadFirstCut()

Description:

This returns the value for the thread first cut amount set in the feature UI pages.

Usage:

variable_name = LATHE_GetThreadFirstCut()

Function:

double LATHE_GetThreadLead()

Description:

This returns the value for the thread pitch amount set in the feature UI pages.

Usage:

variable_name = LATHE_GetThreadLead()

Function:

double LATHE_GetAngleIn()

Description:

This returns the value for the thread lead-in angle set in the feature UI pages.

Usage:

variable_name = LATHE_GetAngleIn()

Function:

double LATHE_GetAngleIn()

Description:

This returns the value for the thread lead-in angle set in the feature UI pages.

Usage:

variable_name = LATHE_GetAngleIn()

Function:

double LATHE_GetThreadLastCut()

Description:

This returns the value for the last cut amount set in the feature UI pages.

Usage:

variable_name = LATHE_GetThreadLastCut()

Function:

double LATHE_GetThreadMachineAllowance()

Description:

This returns the value for the thread machine allowance set in the post in question #413.

Usage:

variable_name = LATHE_GetThreadMachineAllowance()

Function:

double LATHE_GetThreadMachineAllowance()

Description:

This returns the value for the thread machine allowance set in the post in question #413.

Usage:

variable_name = LATHE_GetThreadMachineAllowance()

Function:

double LATHE_GetThreadXMove()

Description:

This returns the value for the thread X move in a long hand threading cycle.   This does not update with values when in a canned threading cycle.

Usage:

variable_name = LATHE_GetThreadXMove()

Function:

double LATHE_GetThreadZMove()

Description:

This returns the value for the thread Z move in a long hand threading cycle.   This does not update with values when in a canned threading cycle.

Usage:

variable_name = LATHE_GetThreadZMove()

Function:

double LATHE_GetThreadFeedRate()

Description:

This returns the value for the thread federate when the threading cycle type is set to separate moves. 

Usage:

variable_name = LATHE_GetThreadFeedRate()

Function:

string LATHE_GetThreadG33GCode()

Description:

This returns the assigned string for the G33 cycle code defined in the post on question #822. 

Usage:

variable_name = LATHE_GetThreadG33GCode()

Function:

double  LATHE_GetThreadAngle()

Description:

This returns the angle (in degrees) of the line selected for the threading operation.

Usage:

variable_name = LATHE_GetThreadAngle()

Function:

double LATHE_GetProfileStartX()

Description:

This returns the X axis starting value of the profile. 

Usage:

variable_name = LATHE_GetProfileStartX()

Function:

double LATHE_GetProfileStartZ()

Description:

This returns the Z axis starting value of the profile. 

Usage:

variable_name = LATHE_GetProfileStartZ()

Function:

double LATHE_GetProfileEndX()

Description:

This returns the X axis ending value of the profile. 

Usage:

variable_name = LATHE_GetProfileEndX()

Function:

double LATHE_GetProfileEndZ()

Description:

This returns the Z axis ending value of the profile. 

Usage:

variable_name = LATHE_GetProfileEndZ()

Function:

double LATHE_GetUserCheckBoxVariable(short index)

Return Values:

0 = Not selected

1 = Selected

Description:

This returns the state of the check box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = LATHE_GetUserCheckBoxVariable(short Index)

Function:

short LATHE_GetUserEditIntegerVariable(short index)

Description:

Returns the value entered in the edit box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = LATHE_GetUserEditIntegerVariable(short Index)

Function:

double LATHE_GetUserEditRealVariable(short index)

Description:

Returns the value entered in the edit box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = LATHE_GetUserEditRealVariable(short Index)

Function:

string LATHE_GetUserEditStringVariable(short index)

Description:

Returns the value entered in the edit box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = LATHE_GetUserEditStringVariable(short Index)

Function:

short LATHE_GetUserSelectComboVariable(short index)

Description:

Returns the selected index of the specified combobox in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = LATHE_GetUserSelectComboVariable(short Index)

Function:

short LATHE_GetUserCheckBoxSettingsVariable(short index)

Return Values:

0 = Not selected

1 = Selected

Description:

Returns the state of the check box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = MILL_GetUserCheckBoxVariable(short index)

Function:

short LATHE_GetUserSelectComboSettingsVariable(short index)

Description:

Returns the selected index of the specified combo box in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = MILL_GetUserSelectComboSettingsVariable(short index)

Function:

short LATHE_GetUserEditIntegerSettingsVariable(short index)

Description:

Returns the value entered in the edit box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = MILL_GetUserEditIntegerSettingsVariable(short index)

Function:

double LATHE_GetUserEditRealSettingsVariable(short index)

Description:

Returns the value entered in the edit box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = MILL_GetUserEditRealSettingsVariable(short index)

Function:

string LATHE_GetUserEditStringSettingsVariable(short index)

Description:

Returns the value entered in the edit box at the specified index in the Advanced Posting page of the Current Settings dialog box.

Usage:

variable_name = MILL_GetUserEditStringSettingsVariable(short index)