GO2cam Javascript API  6.11
GO2SOpelist Class Reference

Class for opelist management. More...

Inherits QObject, and CGoeOperationList.

Public Member Functions

 GO2SOpelist ()
 Default constructor.
 
 GO2SOpelist (String dir, String name)
 
 GO2SOpelist (String filename)
 Load an opelist from a file.
 
String GetDirectoryName ()
 
Array< Array< String > > GetFeatureParams ()
 
String GetFileName ()
 
Array< Array< String > > GetUserParams ()
 
Boolean IsLoaded ()
 
GO2SEnum::GO2SError LoadFromDialog (String ctrl_name)
 
GO2SEnum::GO2SError Run ()
 
GO2SEnum::GO2SError SetUserParam (String key, QJSValue value)
 

Detailed Description

Class for opelist management.

Constructor & Destructor Documentation

◆ GO2SOpelist() [1/2]

GO2SOpelist::GO2SOpelist ( String dir,
String name )

Load an opelist from a file

var ope = new GO2SOpelist('opelist', 'MyOplAuto.OPL')
GO2SOpelist()
Default constructor.
Definition GO2SOpelist.hpp:19
Parameters
[in]dirOpelist file directory
[in]nameOpelist file name

◆ GO2SOpelist() [2/2]

GO2SOpelist::GO2SOpelist ( String filename)

Load an opelist from a file.

Parameters
[in]filenameAbsolute Opelist file name

Member Function Documentation

◆ GetDirectoryName()

String GO2SOpelist::GetDirectoryName ( )
inline
Returns
the directory name of the opelist

◆ GetFeatureParams()

Array< Array< String > > GO2SOpelist::GetFeatureParams ( )
Returns
feature parameters of the opelist (label - comment)

◆ GetFileName()

String GO2SOpelist::GetFileName ( )
inline
Returns
the file name of the opelist

◆ GetUserParams()

Array< Array< String > > GO2SOpelist::GetUserParams ( )
Returns
user parameters of the opelist (label - comment)

◆ IsLoaded()

Boolean GO2SOpelist::IsLoaded ( )
inline
Returns
if the opelist is properly loaded and can be used

◆ LoadFromDialog()

GO2SEnum::GO2SError GO2SOpelist::LoadFromDialog ( String ctrl_name)

Load an opelist from a dialog box

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

◆ Run()

GO2SEnum::GO2SError GO2SOpelist::Run ( )

Run the opelist on the current part

var ope = new GO2SOpelist('opelist', 'MyOplAuto.OPL')
if(ope.IsLoaded())
{
ope.Run()
}
Boolean IsLoaded()
Definition GO2SOpelist.hpp:60
Returns
GO2SError.success (0) if success, see GO2SError otherwise

◆ SetUserParam()

GO2SEnum::GO2SError GO2SOpelist::SetUserParam ( String key,
QJSValue value )

Set a user parameter of the opelist (label - comment)

Returns
GO2SError.success if OK
Parameters
[in]keythe key of a Specific parameter defined in the opelist
[in]valuethe value of the parameter