GO2cam Javascript API
GO2SCycleBase Class Reference

Base class for machining cycle and techno functions. More...

Inheritance diagram for GO2SCycleBase:
GO2SMachining GO2SCycle GO2STechnoFunc

Public Member Functions

GO2SEnum::GO2SError AddToFolder (String name)
 
void Delete ()
 Delete a cycle/techno function.
 
String GetName ()
 
Number GetNumberMachiningSet ()
 
Number GetPlaneNumber ()
 
Boolean IsBatch ()
 
Boolean IsError ()
 
Boolean IsHidden ()
 
Boolean IsMachiningSet ()
 
Boolean IsSelect ()
 
Boolean IsWaiting ()
 
void SetBatch (Boolean isBatch)
 
void SetMachiningSet (Boolean isSet)
 
void SetName (String name)
 Set the name of the cycle/techno function.
 
void SetNumberMachiningSet (Number number)
 
void SetSelect (Boolean isSelected)
 
void SetWaiting (Boolean isWaiting)
 
String toString () override
 
- Public Member Functions inherited from GO2SMachining
Array< String > GetEditableParams ()
 
any GetParam (Number key, Number noDevice=0)
 
Boolean IsParamEditable (Number key)
 
GO2SEnum::GO2SError SetParam (Number key, any value, Number noDevice=0)
 

Detailed Description

Base class for machining cycle and techno functions.

Base class for machining cycle

Member Function Documentation

◆ AddToFolder()

GO2SEnum::GO2SError GO2SCycleBase::AddToFolder ( String name)

Add a cycle/techno function to a folder

Remarks
if the folder does not exist, it will be created
Parameters
[in]namename of the folder

◆ GetName()

String GO2SCycleBase::GetName ( )
Returns
the name of the cycle/techno function

◆ GetNumberMachiningSet()

Number GO2SCycleBase::GetNumberMachiningSet ( )
inline
Returns
if a cycle or techno function the machining set number
Version
2026.1

◆ GetPlaneNumber()

Number GO2SCycleBase::GetPlaneNumber ( )
inline
Returns
plane number of a cycle.

◆ IsBatch()

Boolean GO2SCycleBase::IsBatch ( )
inline
Returns
if a cycle/techno function is batched (waiting) or not
Deprecated
since 6.12.210, use IsWaiting() instead

◆ IsError()

Boolean GO2SCycleBase::IsError ( )
inline
Returns
if a cycle/techno function is in error.

◆ IsHidden()

Boolean GO2SCycleBase::IsHidden ( )
inline
Returns
if a cycle/techno function has been hide or not

◆ IsMachiningSet()

Boolean GO2SCycleBase::IsMachiningSet ( )
Returns
if a cycle or techno function is machining set or not
Version
2026.1

◆ IsSelect()

Boolean GO2SCycleBase::IsSelect ( )
inline
Returns
if a cycle/techno function is selected or not

◆ IsWaiting()

Boolean GO2SCycleBase::IsWaiting ( )
inline
Returns
if a cycle or techno function is waiting or not
Version
6.12.210

◆ SetBatch()

void GO2SCycleBase::SetBatch ( Boolean isBatch)
inline

Set the cycle batch (waiting) or not

Version
6.11.205
Deprecated
since 6.12.210, use SetWaiting() instead
Parameters
[in]isBatchValue of the batch

◆ SetMachiningSet()

void GO2SCycleBase::SetMachiningSet ( Boolean isSet)

Set the cycle or techno function machining set

Version
2026.1
Parameters
[in]isSetValue

◆ SetName()

void GO2SCycleBase::SetName ( String name)

Set the name of the cycle/techno function.

Parameters
[in]namethe new name of the cycle

◆ SetNumberMachiningSet()

void GO2SCycleBase::SetNumberMachiningSet ( Number number)

Set the cycle or techno function the machining set number

Version
2026.1
Parameters
[in]numberValue of the number

◆ SetSelect()

void GO2SCycleBase::SetSelect ( Boolean isSelected)
inline

Set the cycle selected or not

Version
6.11.205

◆ SetWaiting()

void GO2SCycleBase::SetWaiting ( Boolean isWaiting)
inline

Set the cycle or techno function waiting or not

Version
6.12.210
Parameters
[in]isWaitingValue

◆ toString()

String GO2SCycleBase::toString ( )
overridevirtual
Returns
printable information about the object

Implements GO2SMachining.