Class FTQuantifierSetting

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

Constructor

FTQuantifierSetting()

Creates a new object of this class

Parameters

• luaTable - to store named parameters

Obligatory named parameters

• pTaskFT : TaskFT - to which this quantifier setting belongs
• nFTQuantifierTypeCode : integer - FTQuantifierType code to define this quantifier type

Optional named parameters

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

GenerationHintFlag	If there are available hints from the last task run
GenerationHintValueMax	Hint from the last task run - the highest 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 TaskFT
ParamAlpha	Value of the Alpha-parameter
ParamBASECEILAbs	Absolute value threshold for BASE and CEIL quantifiers
ParamBASECEILRel	Relative value threshold for BASE and CEIL quantifiers
ParamBASECEILRelativeFlag	Legacy parameter for BASE and CEIL quantifiers to set relative value of threshold
ParamBeta	Value of the Beta-parameter
ParamDelta	Value of the Delta-parameter
ParamP	Value of the p-parameter, used mainly in implicational quantifiers
ThresholdValue	Universal threshold value (alias for ParamP, ParamAlpha... used in partical types of quantifiers)

Methods List

canDel ()	Returns true if the object could be deleted (is not used)
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
getFTQuantifierTypeCode ()	Returns code of quantifier type for this quantifier, see FTQuantifierType codes
getFTQuantifierTypeKey ()	Returns unique string key of quantifier type for this quantifier
getFTQuantifierTypeName ()	Returns string representation of quantifier type for this quantifier
getFTQuantifierValueTypeCode ()	Returns code of absolute/relative type threshold value of aggregational quantifiers, see FTQuantifierValueType codes
getFTQuantifierValueTypeKey ()	Returns unique string key of absolute/relative type threshold value of aggregational quantifiers
getFTQuantifierValueTypeName ()	Returns string representation of absolute/relative type threshold value of aggregational quantifiers
getGenerationHintValueMax ()	Returns the value of GenerationHintValueMax property
getGenerationHintValueMin ()	Returns the value of GenerationHintValueMin property
getID ()	Returns unique identifier (primary key) of the object
getNote ()	Returns the value of Note property
getOrder ()	Returns the value of Order property
getParamAlpha ()	Returns the value of ParamAlpha property
getParamBASECEILAbs ()	Returns the value of ParamBASECEILAbs property
getParamBASECEILRel ()	Returns the value of ParamBASECEILRel property
getParamBeta ()	Returns the value of ParamBeta property
getParamDelta ()	Returns the value of ParamDelta property
getParamP ()	Returns the value of ParamP property
getTaskFT ()	Returns the TaskFT, the task this quantifier setting belongs to
getThresholdValue ()	Returns the value of ThresholdValue property
isGenerationHintFlag ()	Returns the value of GenerationHintFlag property
isParamBASECEILRelativeFlag ()	Returns the value of ParamBASECEILRelativeFlag 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
setCompareTypeCode ()	Sets code of comparation type for threshold value of aggregational quantifiers, see CompareType codes
setFTQuantifierTypeCode ()	Sets code of quantifier type for this quantifier, see FTQuantifierType codes
setFTQuantifierValueTypeCode ()	Sets code of absolute/relative type threshold value of aggregational quantifiers, see FTQuantifierValueType codes
setNote ()	Sets the value of Note property
setOrder ()	Sets the value of Order property
setParamAlpha ()	Sets the value of ParamAlpha property
setParamBASECEILAbs ()	Sets the value of ParamBASECEILAbs property
setParamBASECEILRel ()	Sets the value of ParamBASECEILRel property
setParamBASECEILRelativeFlag ()	Sets the value of ParamBASECEILRelativeFlag property
setParamBeta ()	Sets the value of ParamBeta property
setParamDelta ()	Sets the value of ParamDelta property
setParamP ()	Sets the value of ParamP property
setThresholdValue ()	Sets the value of ThresholdValue property

Properties

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 highest 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 TaskFT

ParamAlpha : float

Value of the Alpha-parameter

ParamBASECEILAbs : float

Absolute value threshold for BASE and CEIL quantifiers

ParamBASECEILRel : float

Relative value threshold for BASE and CEIL quantifiers

ParamBASECEILRelativeFlag : boolean

Legacy parameter for BASE and CEIL quantifiers to set relative value of threshold

ParamBeta : float

Value of the Beta-parameter

ParamDelta : float

Value of the Delta-parameter

ParamP : float

Value of the p-parameter, used mainly in implicational quantifiers

ThresholdValue : float

Universal threshold value (alias for ParamP, ParamAlpha... used in partical types of quantifiers)

Methods

canDel() : boolean

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

Returns

• boolean

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

getFTQuantifierTypeCode() : integer

Returns code of quantifier type for this quantifier, see FTQuantifierType codes

Returns

• integer

getFTQuantifierTypeKey() : string

Returns unique string key of quantifier type for this quantifier

Returns

• string

getFTQuantifierTypeName() : string

Returns string representation of quantifier type for this quantifier

Returns

• string

getFTQuantifierValueTypeCode() : integer

Returns code of absolute/relative type threshold value of aggregational quantifiers, see FTQuantifierValueType codes

Returns

• integer

getFTQuantifierValueTypeKey() : string

Returns unique string key of absolute/relative type threshold value of aggregational quantifiers

Returns

• string

getFTQuantifierValueTypeName() : string

Returns string representation of absolute/relative type threshold value of aggregational quantifiers

Returns

• string

getGenerationHintValueMax() : float

Returns the value of GenerationHintValueMax property

Returns

• float

getGenerationHintValueMin() : float

Returns the value of GenerationHintValueMin property

Returns

• float

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

getParamAlpha() : float

Returns the value of ParamAlpha property

Returns

• float

getParamBASECEILAbs() : float

Returns the value of ParamBASECEILAbs property

Returns

• float

getParamBASECEILRel() : float

Returns the value of ParamBASECEILRel property

Returns

• float

getParamBeta() : float

Returns the value of ParamBeta property

Returns

• float

getParamDelta() : float

Returns the value of ParamDelta property

Returns

• float

getParamP() : float

Returns the value of ParamP property

Returns

• float

getTaskFT() : TaskFT

Returns the TaskFT, the task this quantifier setting belongs to

Returns

• TaskFT

getThresholdValue() : float

Returns the value of ThresholdValue property

Returns

• float

isGenerationHintFlag() : boolean

Returns the value of GenerationHintFlag property

Returns

• boolean

isParamBASECEILRelativeFlag() : boolean

Returns the value of ParamBASECEILRelativeFlag 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

setCompareTypeCode( integer )

Sets code of comparation type for threshold value of aggregational quantifiers, see CompareType codes

Parameters

• integer

setFTQuantifierTypeCode( integer )

Sets code of quantifier type for this quantifier, see FTQuantifierType codes

Parameters

• integer

setFTQuantifierValueTypeCode( integer )

Sets code of absolute/relative type threshold value of aggregational quantifiers, see FTQuantifierValueType codes

Parameters

• integer

setNote( string )

Sets the value of Note property

Parameters

• string

setOrder( integer )

Sets the value of Order property

Parameters

• integer

setParamAlpha( float )

Sets the value of ParamAlpha property

Parameters

• float

setParamBASECEILAbs( float )

Sets the value of ParamBASECEILAbs property

Parameters

• float

setParamBASECEILRel( float )

Sets the value of ParamBASECEILRel property

Parameters

• float

setParamBASECEILRelativeFlag( boolean )

Sets the value of ParamBASECEILRelativeFlag property

Parameters

• boolean

setParamBeta( float )

Sets the value of ParamBeta property

Parameters

• float

setParamDelta( float )

Sets the value of ParamDelta property

Parameters

• float

setParamP( float )

Sets the value of ParamP property

Parameters

• float

setThresholdValue( float )

Sets the value of ThresholdValue property

Parameters

• float