Interface for the declaration of parameters which could be configured by external sources. These parameters are available for example while preparing platforms for testing. There the parameters can be configured individually for each part of the platform.

Integer nGroupOptional

A group with this attribute is optional so that the user in the host application can enable or disable this group. All parameters in the parameter group are enabled or disable accordingly. If this attribute is not set then the group is always enabled.

Integer nGroupEnabled

With this attribute the parameter group is enabled by default. Nevertheless the user in the host application can disable the group (if nGroupOptional is set). If this attribute is not specified then the parameter group is disabled by default.

Integer nGroupPlatform

This attribute defines a parameter group which is related to the platform instead of individual parts on the platform. If this attribute is not set then the parameter group is considered to be related to individual parts.

Examples for platform related parameters:

• The sorting direction of building up the parts on the platform (e.g. X or Y)

• Any kind of parameter which has influence on the platform’s file export.

Integer nGroupDefaultFlags

This attribute defines the default settings of a parameter group. if ‘declareParameterGroup’ is called without providing any ‘nAttributes’ value, then the group is created with nGroupDefaultFlags.

By default a parameter group is enabled, non-optional and part-related. Therefore nGroupDefaultFlags equals nGroupEnabled.

bsBuildParam.declareParameterGroup(sId, sName, sDescription, nAttributes)

Declares a new group of parameters with a unique identifier sId and name sName.

Examples for nAttributes

• nAttributes = nGroupDefaultFlags | nGroupPlatform : Non-optional platform related parameter group.

• nAttributes = nGroupDefaultFlags & ~nGroupEnabled | nGroupOptional : Optional part-related parameter group which is disabled by default.

Arguments:

• sId : Unique identifier for parameter group

• sName : Name for parameter group

• sDescription : Detailed description for parameter group (optional)

• nAttributes : Group boolean attributes. A combination of the group attribute flags (nGroupOptional, nGroupEnabled, nGroupPlatform). nAttributes is an optional argument. The default setting is nGroupDefaultFlags.

bsBuildParam.declareParameterInt(sGroupId, sId, sName, nMin, nMax, nDefault, sDescription, sUnit)

Declares an integer value parameter.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• nMin : Minimum value of the parameter

• nMax : Maximum value of the parameter

• nDefault : Default value of the parameter

• sDescription : Detailed description of the parameter (optional)

• sUnit : Parameter unit. E.g. “mm” (optional)

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

Declares a floating point value parameter.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• fMin : Minimum value of the parameter

• fMax : Maximum value of the parameter

• fDefault : Default value of the parameter

• sDescription : Detailed description of the parameter (optional)

• sUnit : Parameter unit. E.g. “mm” (optional)

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

Declares a boolean value parameter.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• bDefault : Default value of the parameter

• sDescription : Detailed description of the parameter (optional)

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

Declares a multiple-choice parameter. sOptions can be a single string (“;” separated) or an array of strings.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• sOptions : List of elements (“;” separated). E.g. “low;high;very high” or e.g. [“low”,”high”,”very high”]

• sDefault : Default value of the parameter. Must be one of the elements listed in a_options.

• sDescription : Detailed description of the parameter (optional)

• sUnit : Parameter unit. E.g. “mm” (optional)

bsBuildParam.declareParameterStr(sGroupId, sId, sName, sDefault, sDescription)

Declares a string value parameter. This parameter type is intended for single line text.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• sDefault : Default value of the parameter

• sDescription : Detailed description of the parameter (optional)

bsBuildParam.declareParameterMultiLineStr(sGroupId, sId, sName, sDefault, sDescription)

Declares a string value parameter. This parameter type is intended for longer text containing line breaks. There is a size limit of 64MB for this type of string.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• sDefault : Default value of the parameter

• sDescription : Detailed description of the parameter (optional)

bsBuildParam.declareParameterBase64Str(sGroupId, sId, sName, sDefault, sDescription)

Declares a string value parameter. This parameter type is intended to store any kind of data as a base64 encoded string. The string is allowed to contain additional whitespace characters and line breaks. There is a size limit of 64MB for this type of string.

Arguments:

• sGroupId : Unique identifier of the belonging group of parameters

• sId : Unique identifier of the new parameter

• sName : Name of the new parameter

• sDefault : Default value of the parameter

• sDescription : Detailed description of the parameter (optional)