GO2cam Javascript API  6.11
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 ()
 
Boolean IsBatch ()
 
Boolean IsError ()
 
Boolean IsHidden ()
 
Boolean IsSelect ()
 
void SetBatch (Boolean isBatch)
 
void SetName (String name)
 Set the name of the cycle/techno function.
 
void SetSelect (Boolean isSelected)
 
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

◆ IsBatch()

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

◆ 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

◆ IsSelect()

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

◆ SetBatch()

void GO2SCycleBase::SetBatch ( Boolean isBatch)
inline

Set the cycle batch or not

Version
6.11.205
Parameters
[in]isBatchValue of the batch

◆ SetName()

void GO2SCycleBase::SetName ( String name)

Set the name of the cycle/techno function.

Parameters
[in]namethe new name of the cycle

◆ SetSelect()

void GO2SCycleBase::SetSelect ( Boolean isSelected)
inline

Set the cycle selected or not

Version
6.11.205

◆ toString()

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

Implements GO2SMachining.