LISp-Miner Control Language Reference, version: 27.13.00 of 13 Aug 2017

Class TaskGroup

Group of data-mining tasks
inherits from LMWrapName
namespace: lm.tasks

Constructor

TaskGroup()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • name : string - unique name for the new group of tasks

Properties List

ID  Unique identifier (primary key) of the object
Name  Unique name of this object. Cannot be empty.
Note  Text comment to this object (up to 255 characters)

Methods List

canDel () Returns true if the object could be deleted (is not used)
findTask () Tries to look-up a Task with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Task with this property doesn't exists.
getID () Returns unique identifier (primary key) of the object
getName () Returns the value of Name property, name of this object
getNote () Returns the value of Note property
onAdd () Store the newly created object into metabase
onDel () Delete the object from metabase (fails if canDel returns false)
onUpdate () Save changes made to the object into metabase
prepareTaskArray () Returns array of tasks in this group of tasks. Returns objects of descendant classes (eg. TaskFT). An optional parameter could be specified to filter only tasks of a given type, see TaskSubType codes
queryTaskGenerationStatusAll () Re-reads tasks states from metabase and returns number of tasks for which theirs state has changed from isTaskGenerationStatusInProcess to isTaskGenerationStatusFinished
runAllAndWaitForResults () Starts all tasks (with not isTaskGenerationStatusInProcess) in this group of tasks and waits till all of them have finished
runAllAsync () Starts all tasks (with not isTaskGenerationStatusInProcess) in this group of tasks in parallel threads and returns immediately
setName () Sets the value of Name property, name of this object (must be unique)
setNote () Sets the value of Note property
waitForResultsAll () Waits till all tasks with isTaskGenerationStatusInProcess have finished

Properties

ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
Name : string
Unique name of this object. Cannot be empty.
Intherited from: LMWrapName
Note : string
Text comment to this object (up to 255 characters)
Intherited from: LMWrapName

Methods

canDel() : boolean
Returns true if the object could be deleted (is not used)
Intherited from: LMWrap

Returns

  • boolean
findTask() : Task
Tries to look-up a Task with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Task with this property doesn't exists.

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nID : integer - an ID of the task to look-up
  • name : string - a name of the task to look-up

Returns

getID() : integer
Returns unique identifier (primary key) of the object
Intherited from: LMWrap

Returns

  • integer
getName() : string
Returns the value of Name property, name of this object
Intherited from: LMWrapName

Returns

  • string
getNote() : string
Returns the value of Note property
Intherited from: LMWrapName

Returns

  • string
onAdd()
Store the newly created object into metabase
Intherited from: LMWrap
onDel()
Delete the object from metabase (fails if canDel returns false)
Intherited from: LMWrap
onUpdate()
Save changes made to the object into metabase
Intherited from: LMWrap
prepareTaskArray() : luaTable
Returns array of tasks in this group of tasks. Returns objects of descendant classes (eg. TaskFT). An optional parameter could be specified to filter only tasks of a given type, see TaskSubType codes

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • pDataTable : DataTable - database table the tasks should be based upon
  • nTaskSubTypeCode : integer - TaskSubType code to filter only tasks of a given type

Returns

  • luaTable
queryTaskGenerationStatusAll() : integer
Re-reads tasks states from metabase and returns number of tasks for which theirs state has changed from isTaskGenerationStatusInProcess to isTaskGenerationStatusFinished

Returns

  • integer - number of tasks with state change
runAllAndWaitForResults()
Starts all tasks (with not isTaskGenerationStatusInProcess) in this group of tasks and waits till all of them have finished

Parameters

  • luaTable - to store named parameters
  • luaTable - to store named parameters

Optional named parameters

  • nTargetPlatform : integer - TargetPlatform code
  • bForceRunFinished : boolean - if true, forces all tasks to be run again even if they are already finished

Returns

  • integer - number of launched tasks
runAllAsync()
Starts all tasks (with not isTaskGenerationStatusInProcess) in this group of tasks in parallel threads and returns immediately

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nTargetPlatform : integer - TargetPlatform code
  • bForceRunFinished : boolean - if true, forces all tasks to be run again even if they are already finished

Returns

  • integer - number of launched tasks
setName( string )
Sets the value of Name property, name of this object (must be unique)
Intherited from: LMWrapName

Parameters

  • string - cannot be empty
setNote( string )
Sets the value of Note property
Intherited from: LMWrapName

Parameters

  • string
waitForResultsAll()
Waits till all tasks with isTaskGenerationStatusInProcess have finished

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nSleepTime : integer - time (in milliseconds) between two checks for change in metabase