LISp-Miner Control Language Reference, version: 27.11.00 of 17 Jun 2017

Class HypothesisGroup

A group of hypotheses
inherits from LMWrapName
namespace: lm.tasks.results

Constructor

HypothesisGroup()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • name : string - unique name for the new of HypothesisGroups
  • pTask : Task - task this group of hypotheses belongs to

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)
findHypothesis () Tries to look-up a Hypothesis with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Hypothesis with this property doesn't exists.
getHypothesisCount () Returns number of found hypotheses (if the value of TaskGenerationStatus property is equal or greater then Running, see TaskGenerationStatus codes
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
insertHypothesis () Inserts hypothesis into this group. An hypothesis could belong to multiple groups at once.
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
prepareHypothesisArray () Returns array of Hypothesis'ses in this task
removeHypothesis () Removes hypothesis from this group
setName () Sets the value of Name property, name of this object (must be unique)
setNote () Sets the value of Note property

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
findHypothesis() : Hypothesis
Tries to look-up a Hypothesis with a unique property given as parameter. Just one parameter has to be specified. Returns nil if Hypothesis with this property doesn't exists.

Parameters

  • luaTable - to store named parameters

Optional named parameters

  • nID : integer - an ID of the Hypothesis to look-up

Returns

getHypothesisCount() : integer
Returns number of found hypotheses (if the value of TaskGenerationStatus property is equal or greater then Running, see TaskGenerationStatus codes

Returns

  • integer
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
insertHypothesis()
Inserts hypothesis into this group. An hypothesis could belong to multiple groups at once.

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pHypothesis : Hypothesis - to insert to this group
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
prepareHypothesisArray() : luaTable
Returns array of Hypothesis'ses in this task

Returns

  • luaTable
removeHypothesis()
Removes hypothesis from this group

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pHypothesis : Hypothesis - to remove from this group
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