sgr_commhandler.api.dynamic_parameter

Provides dynamic request parameters.

Attributes

logger

Classes

DynamicParameter

Implements a dynamic parameter of data points.

Functions

build_dynamic_parameters(params)	Constructs a dynamic parameter list.
build_dynamic_parameter_substitutions(...)	Builds dynamic parameter substitutions, to be used in data point requests.

Module Contents

sgr_commhandler.api.dynamic_parameter.logger

sgr_commhandler.api.dynamic_parameter.build_dynamic_parameters(params)

Constructs a dynamic parameter list.

Parameters:

params (Optional[DynamicParameterDescriptionList]) – The dynamic parameter list of a data point

Returns:

a list of dynamic parameters

Return type:

list[DynamicParameter]

sgr_commhandler.api.dynamic_parameter.build_dynamic_parameter_substitutions(dynamic_parameters, input_parameters)

Builds dynamic parameter substitutions, to be used in data point requests. Only parameters defined in the dynamic parameter list are kept. Parameters not defined in the properties are set to the default value.

Parameters:

• dynamic_parameters (list[DynamicParameter]) – the dynamic parameters as specified

• input_parameters (Optional[dict[str, str]]) – the actual parameters given to the request

Returns:

the final substitutions as dictionary

Return type:

Dict[str, str]

class sgr_commhandler.api.dynamic_parameter.DynamicParameter(parameter)

Implements a dynamic parameter of data points.

Parameters:

parameter (sgr_specification.v0.generic.base_types.DynamicParameterDescriptionListElement)

label

name

type

description

default_value

__str__()

Converts to string.

Returns:

A string

Return type:

str

__repr__()

Gets an object description as string.

Returns:

A string

Return type:

str