GO2SMachining Class Reference

Base class for all machining object. More...

Inheritance diagram for GO2SMachining:

Public Member Functions
Array< String >	GetEditableParams ()
any	GetParam (Number key, Number noDevice=0)
Boolean	IsParamEditable (Number key)
GO2SEnum::GO2SError	SetParam (Number key, any value, Number noDevice=0)
String	toString ()=0

Detailed Description

Base class for all machining object.

Member Function Documentation

GetEditableParams()

Array< String > GO2SMachining::GetEditableParams

(

)

Returns

the list of all editable parameters

GetParam()

any GO2SMachining::GetParam	(	Number	key,
		Number	noDevice = 0 )

Returns

a parameter if possible

Parameters

[in]	key	the parameter key
[in]	noDevice	the device number (for machines and tool holders)

IsParamEditable()

Boolean GO2SMachining::IsParamEditable

(

Number

key

)

Returns

if the given parameter is editable

console.log(GO2SMachiningUtil.IsParamEditable(REAL_MILL_TOOL_STEPOVER_RATIO));

Parameters

[in]

key

Parameter key number

SetParam()

GO2SEnum::GO2SError GO2SMachining::SetParam	(	Number	key,
		any	value,
		Number	noDevice = 0 )

Change the parameter if possible Use GetEditableParams() to get the list of editable parameters

Returns

GO2SError.success(0) if success, see GO2SError otherwise

Parameters

[in]	key	the parameter key
[in]	value	the parameter value
[in]	noDevice	the device number (for machines and tool holders)

toString()

String GO2SMachining::toString ( )

pure virtual

Returns

printable information about the object

Implemented in GO2SCycleBase, GO2SMachine, and GO2STool.