LISp-Miner Control Language Reference, version: 27.13.01 of 25 Aug 2017

Class CFQuantifierSetting

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

Constructor

CFQuantifierSetting()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pTaskCF : TaskCF - to which this quantifier setting belongs
  • nCFQuantifierTypeCode : integer - CFQuantifierType code to define this quantifier type

Optional named parameters

  • nCompareTypeCode : integer - CompareType code to define relation between interest measure and threshold value
  • nCFQuantifierValueTypeCode : integer - CFQuantifierValueType 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

FromCol  Absolute or relative index of the leCF boundary of range of frequencies from the histogram. Relative position is given by a negative number
GenerationHintFlag  If there are available hints from the last task run
GenerationHintValueMax  Hint from the last task run - the lowest found interest measure for this quantifier
GenerationHintValueMin  Hint from the last task run - the lowest found interest measure for this quantifier
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 TaskCF
RangeRelFlag  If the range From-To is specified in percentage form
StepsConsecutiveFlag  Consecutive steps (threshold is for the longest interrupeted sequence of steps)
StepSize  Minimal step size
ThresholdValue  CF-Quantifiers threshold value
ToCol  Absolute or relative index of the right boundary of range of frequencies To the histogram. Relative position is given by a negative number

Methods List

canDel () Returns true if the object could be deleted (is not used)
GenerationHintFlag () Returns the value of GenerationHintFlag property
GenerationHintValueMax () Returns the value of GenerationHintValueMax property
GenerationHintValueMin () Returns the value of GenerationHintValueMin property
getCFQuantifierHistogramValueTypeCode () Returns code of type of possible transformation of frequencies, see CFQuantifierHistogramValueType codes
getCFQuantifierHistogramValueTypeKey () Returns unique string key of type of possible transformation of frequencies
getCFQuantifierHistogramValueTypeName () Returns string representation of type of possible transformation of frequencies
getCFQuantifierStepCountTypeCode () Returns code of absolute/relative type of step-count units, see CFQuantifierStepCountType codes
getCFQuantifierStepCountTypeKey () Returns unique string key of absolute/relative type of step-count units
getCFQuantifierStepCountTypeName () Returns string representation of absolute/relative type of step-count units
getCFQuantifierStepSizeTypeCode () Returns code of absolute/relative type of minimal-step-size units, see CFQuantifierStepSizeType codes
getCFQuantifierStepSizeTypeKey () Returns unique string key of absolute/relative type of minimal-step-size units
getCFQuantifierStepSizeTypeName () Returns string representation of absolute/relative type of minimal-step-size units
getCFQuantifierTypeCode () Returns code of quantifier type for this quantifier, see CFQuantifierType codes
getCFQuantifierTypeKey () Returns unique string key of quantifier type for this quantifier
getCFQuantifierTypeName () Returns string representation of quantifier type for this quantifier
getCFQuantifierValueTypeCode () Returns code of absolute/relative type threshold value of aggregational quantifiers, see CFQuantifierValueType codes
getCFQuantifierValueTypeKey () Returns unique string key of absolute/relative type threshold value of aggregational quantifiers
getCFQuantifierValueTypeName () Returns string representation of absolute/relative type threshold value of aggregational quantifiers
getCompareTypeCode () Returns code of comparation type for threshold value of aggregational quantifiers, see CompareType codes
getCompareTypeKey () Returns unique string key of comparation type for threshold value of aggregational quantifiers
getCompareTypeName () Returns string representation of comparation type for threshold value of aggregational quantifiers
getFromCol () Returns the value of FromCol property
getID () Returns unique identifier (primary key) of the object
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
getStepSize () Returns the value of StepSize property
getTaskCF () Returns the TaskCF, the task this quantifier setting belongs to
getThresholdValue () Returns the value of ThresholdValue property
getToCol () Returns the value of ToCol property
isStepsConsecutiveFlag () Returns the value of StepsConsecutive 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
setCFQuantifierHistogramValueTypeCode () Sets code of type of possible transformation of frequencies, see CFQuantifierHistogramValueType codes
setCFQuantifierStepCountTypeCode () Sets code of absolute/relative type of step-count units, see CFQuantifierStepCountType codes
setCFQuantifierStepSizeTypeCode () Sets code of absolute/relative type of minimal-step-size units, see CFQuantifierStepSizeType codes
setCFQuantifierTypeCode () Sets code of quantifier type for this quantifier, see CFQuantifierType codes
setCFQuantifierValueTypeCode () Sets code of absolute/relative type threshold value of aggregational quantifiers, see CFQuantifierValueType codes
setCompareTypeCode () Sets code of comparation type for threshold value of aggregational quantifiers, see CompareType codes
setFromCol () Sets the value of FromCol property
setNote () Sets the value of Note property
setOrder () Sets the value of Order property
setStepsConsecutiveFlag () Sets the value of StepsConsecutive property
setStepSize () Sets the value of StepSize property
setThresholdValue () Sets the value of ThresholdValue property
setToCol () Sets the value of ToCol property

Properties

FromCol : integer
Absolute or relative index of the leCF boundary of range of frequencies from the histogram. Relative position is given by a negative number
GenerationHintFlag  (read-only) : boolean
If there are available hints from the last task run
GenerationHintValueMax  (read-only) : float
Hint from the last task run - the lowest found interest measure for this quantifier
GenerationHintValueMin  (read-only) : float
Hint from the last task run - the lowest found interest measure for this quantifier
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 TaskCF
RangeRelFlag  (read-only) : boolean
If the range From-To is specified in percentage form
StepsConsecutiveFlag : boolean
Consecutive steps (threshold is for the longest interrupeted sequence of steps)
StepSize : float
Minimal step size
ThresholdValue : float
CF-Quantifiers threshold value
ToCol : integer
Absolute or relative index of the right boundary of range of frequencies To the histogram. Relative position is given by a negative number

Methods

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

Returns

  • boolean
GenerationHintFlag() : boolean
Returns the value of GenerationHintFlag property

Returns

  • boolean
GenerationHintValueMax() : float
Returns the value of GenerationHintValueMax property

Returns

  • float
GenerationHintValueMin() : float
Returns the value of GenerationHintValueMin property

Returns

  • float
getCFQuantifierHistogramValueTypeCode() : integer
Returns code of type of possible transformation of frequencies, see CFQuantifierHistogramValueType codes

Returns

  • integer
getCFQuantifierHistogramValueTypeKey() : string
Returns unique string key of type of possible transformation of frequencies

Returns

  • string
getCFQuantifierHistogramValueTypeName() : string
Returns string representation of type of possible transformation of frequencies

Returns

  • string
getCFQuantifierStepCountTypeCode() : integer
Returns code of absolute/relative type of step-count units, see CFQuantifierStepCountType codes

Returns

  • integer
getCFQuantifierStepCountTypeKey() : string
Returns unique string key of absolute/relative type of step-count units

Returns

  • string
getCFQuantifierStepCountTypeName() : string
Returns string representation of absolute/relative type of step-count units

Returns

  • string
getCFQuantifierStepSizeTypeCode() : integer
Returns code of absolute/relative type of minimal-step-size units, see CFQuantifierStepSizeType codes

Returns

  • integer
getCFQuantifierStepSizeTypeKey() : string
Returns unique string key of absolute/relative type of minimal-step-size units

Returns

  • string
getCFQuantifierStepSizeTypeName() : string
Returns string representation of absolute/relative type of minimal-step-size units

Returns

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

Returns

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

Returns

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

Returns

  • string
getCFQuantifierValueTypeCode() : integer
Returns code of absolute/relative type threshold value of aggregational quantifiers, see CFQuantifierValueType codes

Returns

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

Returns

  • string
getCFQuantifierValueTypeName() : string
Returns string representation of absolute/relative type threshold value of aggregational quantifiers

Returns

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

Returns

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

Returns

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

Returns

  • string
getFromCol() : integer
Returns the value of FromCol property

Returns

  • integer
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
getStepSize() : float
Returns the value of StepSize property

Returns

  • float
getTaskCF() : TaskCF
Returns the TaskCF, the task this quantifier setting belongs to

Returns

getThresholdValue() : float
Returns the value of ThresholdValue property

Returns

  • float
getToCol() : integer
Returns the value of ToCol property

Returns

  • integer
isStepsConsecutiveFlag() : boolean
Returns the value of StepsConsecutive property

Returns

  • boolean
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
setCFQuantifierHistogramValueTypeCode( integer )
Sets code of type of possible transformation of frequencies, see CFQuantifierHistogramValueType codes

Parameters

  • integer
setCFQuantifierStepCountTypeCode( integer )
Sets code of absolute/relative type of step-count units, see CFQuantifierStepCountType codes

Parameters

  • integer
setCFQuantifierStepSizeTypeCode( integer )
Sets code of absolute/relative type of minimal-step-size units, see CFQuantifierStepSizeType codes

Parameters

  • integer
setCFQuantifierTypeCode( integer )
Sets code of quantifier type for this quantifier, see CFQuantifierType codes

Parameters

  • integer
setCFQuantifierValueTypeCode( integer )
Sets code of absolute/relative type threshold value of aggregational quantifiers, see CFQuantifierValueType codes

Parameters

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

Parameters

  • integer
setFromCol( integer )
Sets the value of FromCol property

Parameters

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

Parameters

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

Parameters

  • integer
setStepsConsecutiveFlag( boolean )
Sets the value of StepsConsecutive property

Parameters

  • boolean
setStepSize( float )
Sets the value of StepSize property

Parameters

  • float
setThresholdValue( float )
Sets the value of ThresholdValue property

Parameters

  • float
setToCol( integer )
Sets the value of ToCol property

Parameters

  • integer