LISp-Miner Control Language Reference, version: 27.15.02 of 14 Dec 2017

Class AFQuantifierSetting

Set of parameters describing one Ac4ft-quantifier, a criterion on interest measure comparing it to a threshold value
inherits from LMWrap
namespace: lm.tasks.settings

Constructor

AFQuantifierSetting()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pTaskAF : TaskAF - to which this quantifier setting belongs
  • nAFQuantifierTypeCode : integer - AFQuantifierType code to define this quantifier type
  • nACQuantifierSourceTypeCode : integer - ACQuantifierSourceType code to define this quantifier calculation source type

Optional named parameters

  • nCompareTypeCode : integer - CompareType code to define relation between interest measure and threshold value
  • nAFQuantifierValueTypeCode : integer - AFQuantifierValueType code describing threshold value units
  • dThresholdValue : float - universal threshold value (will be assigned to the proper parameter for the given quantifier type)
  • nOrder : integer - position of the quantifier in the list of quantifiers of its task

Properties List

ID  Unique identifier (primary key) of the object
Note  Additional note to this partial cedent
Order  Order-index of this partial cedent in array of partial cedent of its TaskAF
ThresholdValue  Threshold value

Methods List

canDel () Returns true if the object could be deleted (is not used)
getACQuantifierSourceTypeCode () Returns code of calculation source type for this quantifier, see ACQuantifierSourceType codes
getACQuantifierSourceTypeKey () Returns unique string key of calculation source type for this quantifier
getACQuantifierSourceTypeName () Returns string representation of calculation source type for this quantifier
getAFQuantifierTypeCode () Returns code of quantifier type for this quantifier, see AFQuantifierType codes
getAFQuantifierTypeKey () Returns unique string key of quantifier type for this quantifier
getAFQuantifierTypeName () Returns string representation of quantifier type for this quantifier
getAFQuantifierValueTypeCode () Returns code of absolute/relative type threshold value, see AFQuantifierValueType codes
getAFQuantifierValueTypeKey () Returns unique string key of absolute/relative type threshold value
getAFQuantifierValueTypeName () Returns string representation of absolute/relative type threshold value
getCompareTypeCode () Returns code of comparation type for threshold value, see CompareType codes
getCompareTypeKey () Returns unique string key of comparation type for threshold value
getCompareTypeName () Returns string representation of comparation type for threshold value
getID () Returns unique identifier (primary key) of the object
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
getTaskAF () Returns the TaskAF, the task this quantifier setting belongs to
getThresholdValue () Returns the value of Value 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
setACQuantifierSourceTypeCode () Sets code of calculation source type for this quantifier, see ACQuantifierSourceType codes
setAFQuantifierTypeCode () Sets code of quantifier type for this quantifier, see AFQuantifierType codes
setAFQuantifierValueTypeCode () Sets code of absolute/relative type threshold value, see AFQuantifierValueType codes
setCompareTypeCode () Sets code of comparation type for threshold value, see CompareType codes
setNote () Sets the value of Note property
setOrder () Sets the value of Order property
setThresholdValue () Sets the value of Value property

Properties

ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
Note : string
Additional note to this partial cedent
Order : integer
Order-index of this partial cedent in array of partial cedent of its TaskAF
ThresholdValue : float
Threshold value

Methods

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

Returns

  • boolean
getACQuantifierSourceTypeCode() : integer
Returns code of calculation source type for this quantifier, see ACQuantifierSourceType codes

Returns

  • integer
getACQuantifierSourceTypeKey() : string
Returns unique string key of calculation source type for this quantifier

Returns

  • string
getACQuantifierSourceTypeName() : string
Returns string representation of calculation source type for this quantifier

Returns

  • string
getAFQuantifierTypeCode() : integer
Returns code of quantifier type for this quantifier, see AFQuantifierType codes

Returns

  • integer
getAFQuantifierTypeKey() : string
Returns unique string key of quantifier type for this quantifier

Returns

  • string
getAFQuantifierTypeName() : string
Returns string representation of quantifier type for this quantifier

Returns

  • string
getAFQuantifierValueTypeCode() : integer
Returns code of absolute/relative type threshold value, see AFQuantifierValueType codes

Returns

  • integer
getAFQuantifierValueTypeKey() : string
Returns unique string key of absolute/relative type threshold value

Returns

  • string
getAFQuantifierValueTypeName() : string
Returns string representation of absolute/relative type threshold value

Returns

  • string
getCompareTypeCode() : integer
Returns code of comparation type for threshold value, see CompareType codes

Returns

  • integer
getCompareTypeKey() : string
Returns unique string key of comparation type for threshold value

Returns

  • string
getCompareTypeName() : string
Returns string representation of comparation type for threshold value

Returns

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

Returns

  • integer
getNote() : string
Returns the value of Note property

Returns

  • string
getOrder() : integer
Returns the value of Order property

Returns

  • integer
getTaskAF() : TaskAF
Returns the TaskAF, the task this quantifier setting belongs to

Returns

getThresholdValue() : float
Returns the value of Value property

Returns

  • float
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
setACQuantifierSourceTypeCode( integer )
Sets code of calculation source type for this quantifier, see ACQuantifierSourceType codes

Parameters

  • integer
setAFQuantifierTypeCode( integer )
Sets code of quantifier type for this quantifier, see AFQuantifierType codes

Parameters

  • integer
setAFQuantifierValueTypeCode( integer )
Sets code of absolute/relative type threshold value, see AFQuantifierValueType codes

Parameters

  • integer
setCompareTypeCode( integer )
Sets code of comparation type for threshold value, see CompareType codes

Parameters

  • integer
setNote( string )
Sets the value of Note property

Parameters

  • string
setOrder( integer )
Sets the value of Order property

Parameters

  • integer
setThresholdValue( float )
Sets the value of Value property

Parameters

  • float