midgard.collections

midgard.collections.enums

Framework for working with enumerations

Description:

Custom enumerations used for structured names. You can add your own enumerations in your own application by importing register_enum and using that to register your own enums.

Example:

Create your own enumeration:

from midgard.collections.enums import register_enum

@register_enum("reference_ellipsoid")
class ReferenceEllipsoid(enum.IntEnum):

    wgs84 = 1
    grs80 = 2
    wgs72 = 3

Use enumerations in your code:

from midgard.collections import enums
enums.get_value("gnss_freq_G", "L1")
enums.get_value("gnss_freq_G", "L1") + 1

enums.get_enum("gnss_freq_G")
enums.get_enum("gnss_freq_G").L1
enums.get_enum("gnss_freq_G").L1 + 1

enums.gnss_freq_G.L1
enums.gnss_freq_G.L1 * 2

GPSFrequency

Full name: midgard.collections.enums.GPSFrequency

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

GPS frequencies

LogColor

Full name: midgard.collections.enums.LogColor

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

Colors used when logging

LogLevel

Full name: midgard.collections.enums.LogLevel

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

Levels used when deciding how much log output to show

NotGiven

Full name: midgard.collections.enums.NotGiven

Signature: ()

Dummy class used as a marker for a argument not given, used instead of None because None is valid value

WriteLevel

Full name: midgard.collections.enums.WriteLevel

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

Levels used when deciding which fields of a dataset and other information to write to disk

enums()

Full name: midgard.collections.enums.enums

Signature: () -> List[str]

Return a list of available enums

Returns:

Names of available enums.

get_enum()

Full name: midgard.collections.enums.get_enum

Signature: (name:str) -> enum.EnumMeta

Return a named Enumeration

Names are defined by the @register_enum-decorator. If the name-parameter is not a valid enum, the function will raise an UnknownEnumError and list the available enumerations.

Args:

Returns:

Enumeration with the given name.

get_value()

Full name: midgard.collections.enums.get_value

Signature: (name:str, value:str, default:Any=<class 'midgard.collections.enums.NotGiven'>) -> enum.Enum

Return the value of a named Enumeration

Names are defined by the @register_enum-decorator.

Args:

Returns:

Value of enumeration with the given name.

gnss_freq_G

Full name: midgard.collections.enums.gnss_freq_G

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

GPS frequencies

has_value()

Full name: midgard.collections.enums.has_value

Signature: (name:str, value:str) -> bool

Check whether a named Enumeration defines a given value

Args:

Returns:

True if Enumeration defines value, False otherwise

log_color

Full name: midgard.collections.enums.log_color

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

Colors used when logging

log_level

Full name: midgard.collections.enums.log_level

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

Levels used when deciding how much log output to show

register_enum()

Full name: midgard.collections.enums.register_enum

Signature: (name:str) -> Callable[[enum.EnumMeta], enum.EnumMeta]

Register a named Enumeration

This allows for getting Enumerations with the get_enum-function.

Args:

Returns:

Decorator that registers an Enumeration.

write_level

Full name: midgard.collections.enums.write_level

Signature: (value, names=None, *, module=None, qualname=None, type=None, start=1)

Levels used when deciding which fields of a dataset and other information to write to disk