bsParam

Module: bsParam

Interface for reading the values of parameters which could be configured by external sources.

Number getParamReal(sGroupId, sParamId)

Reads the number value of the parameter with the unique identifier sParamId in the group of parameters with the unique identifier sGroupId.

Links: bsBuildParam.declareParameterReal(sGroupId, sId, sName, fMin, fMax, fDefault, sDescription, sUnit)

Arguments:

Return

Value (number) of the parameter. Undefined if parameter is not available.

Integer getParamInt(sGroupId, sParamId)

Reads the integer value of the parameter with the unique identifier sParamId in the group of parameters with the unique identifier sGroupId. If the parameter is of type “choice” (declareParameterChoice) then the index of the selected value is returned.

Links: bsBuildParam.declareParameterInt(sGroupId, sId, sName, nMin, nMax, nDefault, sDescription, sUnit), bsBuildParam.declareParameterChoice(sGroupId, sId, sName, sOptions, sDefault, sDescription, sUnit)

Arguments:

Return

Value (integer) of the parameter. Undefined if parameter is not available.

Boolean getParamBool(sGroupId, sParamId)

Reads the boolean value of the parameter with the unique identifier sParamId in the group of parameters with the unique identifier sGroupId.

Links: bsBuildParam.declareParameterBool(sGroupId, sId, sName, bDefault, sDescription)

Arguments:

Return

Value (boolean) of the parameter. Undefined if parameter is not available.

String getParamStr(sGroupId, sParamId)

Reads the string value of the parameter with the unique identifier sParamId in the group of parameters with the unique identifier sGroupId. Only the “choice” type parameter is able to return the selected value as a string.

Links: bsBuildParam.declareParameterChoice(sGroupId, sId, sName, sOptions, sDefault, sDescription, sUnit)

Arguments:

Return

Value (string) of the parameter. Undefined if parameter is not available.

Boolean isGroupOptional(sGroupId)

Queries whether a parameter group is optional (can be achieved by setting nGroupOptional while declaring the parmeter group). An optional group may have the enabled state set to false while a non-optional group is always enabled.

Links: bsBuildParam

Arguments:

Return

Boolean value: Optional or non-optional group.

Boolean isGroupEnabled(sGroupId)

Queries whether a parameter group is enabled (A group can only be disabled when the nGroupOptional flag is set). A non-optional group is always enabled.

Links: bsBuildParam

Arguments:

Return

Boolean value: The parameter-group is enabled (true) or disabled (false).

Boolean isGroupPlatform(sGroupId)

Queries whether a parameter group is platform related.

Links: bsBuildParam

Arguments:

Return

Boolean value: The parameter-group is platform related (true) or part-related (false).