PMCfgDefinition

data class PMCfgDefinition(val cfgType: PMCfgType, val id: String, val family: PMCfgFamily, val featureName: String? = null, val featureValue: String? = null, val group: String, val name: String, val description: String, val implementation: String? = null, val confidential: Boolean = false, val textTrue: String? = null, val textFalse: String? = null, val intMin: Int = 0, val intMax: Int = 0, val enumValues: List<PMCfgEnumValue>? = null, val defaultBool: Boolean = false, val defaultInt: Int = 0, val defaultString: String? = null, val defaultSet: List<String>? = null, val measurementSystem: PMCfgMeasurementSystem, val guiOrder: String? = null)

definition of one configuration option

Constructors

Link copied to clipboard
fun PMCfgDefinition(cfgType: PMCfgType, id: String, family: PMCfgFamily, featureName: String? = null, featureValue: String? = null, group: String, name: String, description: String, implementation: String? = null, confidential: Boolean = false, textTrue: String? = null, textFalse: String? = null, intMin: Int = 0, intMax: Int = 0, enumValues: List<PMCfgEnumValue>? = null, defaultBool: Boolean = false, defaultInt: Int = 0, defaultString: String? = null, defaultSet: List<String>? = null, measurementSystem: PMCfgMeasurementSystem, guiOrder: String? = null)

Properties

Link copied to clipboard

type of option
Default value is PMCfgType.TypeBool

Link copied to clipboard
val confidential: Boolean = false

true if value is confidential, so it will be not exported

Link copied to clipboard
val defaultBool: Boolean = false

default bool value

Link copied to clipboard
val defaultInt: Int = 0

default int value

Link copied to clipboard
val defaultSet: List<String>? = null

default set or list of enum values, depends on cfgType

Link copied to clipboard
val defaultString: String? = null

default string or enum_one value

Link copied to clipboard

description of option

Link copied to clipboard

list of allowed values

Link copied to clipboard

configuration family
Default value is PMCfgFamily.Internal

Link copied to clipboard
val featureName: String? = null

name of licensed feature

Link copied to clipboard
val featureValue: String? = null

required value of licensed feature

Link copied to clipboard

group of option

Link copied to clipboard
val guiOrder: String? = null

Definition position in Navigation UI ( order on the screen )

Link copied to clipboard
val id: String

id code used in source code

Link copied to clipboard
val implementation: String? = null

implementation comment

Link copied to clipboard
val intMax: Int = 0

for int value : maximum allowed value

Link copied to clipboard
val intMin: Int = 0

for int value : minimal allowed value

Link copied to clipboard

used measurement system, if it's not specified the SI-value is used
Default value is PMCfgMeasurementSystem.SI

Link copied to clipboard

name of option

Link copied to clipboard
val textFalse: String? = null

for bool value : meaning for false-value

Link copied to clipboard
val textTrue: String? = null

for bool value : meaning for true-value