rtm_wrapper.parameters.util#

Misc utilities related to parameter handling.

Module Contents#

Classes#

MetadataDict

Metadata dictionary containing an optional title and unit.

exception ParameterError[source]#

Bases: Exception

Raised on invalid parameter access.

Initialize self. See help(type(self)) for accurate signature.

exception UnsetParameterError[source]#

Bases: ParameterError

Raised on attempt to access an unset parameter.

Initialize self. See help(type(self)) for accurate signature.

class MetadataDict[source]#

Bases: TypedDict

Metadata dictionary containing an optional title and unit.

Initialize self. See help(type(self)) for accurate signature.

title: typing_extensions.NotRequired[str]#

Optional title.

unit: typing_extensions.NotRequired[str]#

Optional unit.