GO2cam Javascript API  6.11
GO2SMachiningUtil Class Reference

Class of machining utility methodes. More...

Inherits QObject.

Static Public Member Functions

static GO2SEnum::GO2SError CreateFolder (String name, Array< GO2SCycleBase > cycles)
 
static void DeleteFolder (String name)
 
static Array< GO2SCycleBaseGetAll ()
 
static Array< GO2SCycleGetAllCycles ()
 
static Array< GO2STechnoFuncGetAllFCTechno ()
 
static Array< GO2SCycleBaseGetByName (String name)
 
static Array< GO2SCycleBaseGetByNameLike (String p1)
 
static Number GetCycleCount ()
 
static Array< GO2SCycleBaseGetFolder (String name)
 
static Number GetProcessCount ()
 
static Array< GO2SCycleBaseGetSelected ()
 
static GO2SEnum::GO2SError LoadMaterial (String dir, String name)
 
static GO2SEnum::GO2SError MoveCycle (GO2SCycleBase cycMove, GO2SEnum::GO2SWay way, GO2SCycleBase cycDest)
 
static GO2SEnum::GO2SError RenameFolder (String name, String newName)
 
static void SetBatchCycle (Boolean isBatch)
 

Detailed Description

Class of machining utility methodes.

Member Function Documentation

◆ CreateFolder()

static GO2SEnum::GO2SError GO2SMachiningUtil::CreateFolder ( String name,
Array< GO2SCycleBase > cycles )
static

Create a folder in machining tree

Warning
The folder name has to be unique
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]nameName of the folder
[in]cyclesArray of cycle to add to the folder.

◆ DeleteFolder()

static void GO2SMachiningUtil::DeleteFolder ( String name)
static

Delete a folder in machining tree

Remarks
the folder content will not be deleted
Parameters
[in]nameName of the folder

◆ GetAll()

static Array< GO2SCycleBase > GO2SMachiningUtil::GetAll ( )
static

Get an array with all cycles

var cycles = GO2SMachiningUtil.GetAll()
Class of machining utility methodes.
Definition GO2SMachiningUtil.hpp:19
static Array< GO2SCycleBase > GetAll()
Returns
all cycles

◆ GetAllCycles()

static Array< GO2SCycle > GO2SMachiningUtil::GetAllCycles ( )
static

Get an array with all cycles

var cycles = GO2SMachiningUtil.GetAll()
Returns
all cycles

◆ GetAllFCTechno()

static Array< GO2STechnoFunc > GO2SMachiningUtil::GetAllFCTechno ( )
static

Get an array with all techno functions

static Array< GO2STechnoFunc > GetAllFCTechno()
Returns
all cycles

◆ GetByName()

static Array< GO2SCycleBase > GO2SMachiningUtil::GetByName ( String name)
static

Get an array of cycles with a given label/name

var cycle = GO2SMachiningUtil.GetCycleByName("Pocket")
Returns
a list of cycles
Parameters
[in]nameName of the cycle

◆ GetByNameLike()

static Array< GO2SCycleBase > GO2SMachiningUtil::GetByNameLike ( String p1)
static

Get an array of all cycles with name containing p1

var cycle = GO2SMachiningUtil.GetCycleByNameLike("Pocket")
Returns
an array of cycles with name containing p1
Parameters
[in]p1part of name

◆ GetCycleCount()

static Number GO2SMachiningUtil::GetCycleCount ( )
static

Get the number of cycles

Returns
cycles count

◆ GetFolder()

static Array< GO2SCycleBase > GO2SMachiningUtil::GetFolder ( String name)
static
Returns
all cycles in a folder
Parameters
[in]nameName of the folder

◆ GetProcessCount()

static Number GO2SMachiningUtil::GetProcessCount ( )
static

Get the number of process

Returns
process count

◆ GetSelected()

static Array< GO2SCycleBase > GO2SMachiningUtil::GetSelected ( )
static

Get all selected cycles

Returns
Array of all selected cycles

◆ LoadMaterial()

static GO2SEnum::GO2SError GO2SMachiningUtil::LoadMaterial ( String dir,
String name )
static

Load a material for the current part

GO2SMachiningUtil.LoadMaterial("", "ACIERS FAIBLEMENT ALLIES.MTR")
static GO2SEnum::GO2SError LoadMaterial(String dir, String name)
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]dirMaterial file destination directory. If empty, the GO2cam material directory will be used
[in]nameMaterial file name

◆ MoveCycle()

static GO2SEnum::GO2SError GO2SMachiningUtil::MoveCycle ( GO2SCycleBase cycMove,
GO2SEnum::GO2SWay way,
GO2SCycleBase cycDest )
static

Move a cycle

var cycle1 = GO2SMachiningUtil.GetByName("Pocket")
var cycle2 = GO2SMachiningUtil.GetByName("Contouring")
GO2SMachiningUtil.MoveCycle(cycle1[0], GO2SWay.after, cycle2[0])
static GO2SEnum::GO2SError MoveCycle(GO2SCycleBase cycMove, GO2SEnum::GO2SWay way, GO2SCycleBase cycDest)
static Array< GO2SCycleBase > GetByName(String name)
Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]cycMovethe cycle to move
[in]wayChoose if the cycle is move before or after the other cycle
[in]cycDestthe other cycle

◆ RenameFolder()

static GO2SEnum::GO2SError GO2SMachiningUtil::RenameFolder ( String name,
String newName )
static

Rename folder

Returns
GO2SError.success (0) if success, see GO2SError otherwise
Parameters
[in]nameName of the existing folder
[in]newNamenew name

◆ SetBatchCycle()

static void GO2SMachiningUtil::SetBatchCycle ( Boolean isBatch)
inlinestatic

Set the batch option of all cycles

Warning
Use this option to create batch cycle with Opelist
Version
6.11.205
Parameters
[in]isBatchValue of the batch