roxieapi.cadata.Definition module

class roxieapi.cadata.Definition.Definition(name: str = '', comment: str = '')[source]

Bases: ABC

Base class for a definition.

name

The name of a definition (serves as a primary key).

Type:

str

comment

The comment.

Type:

str

comment: str = ''
abstract static get_magnum_to_roxie_dct()[source]

Method returning a mapping from MagNum naming convention to ROXIE naming convention.

Returns:

a dictionary from MagNum to ROXIE names

classmethod get_roxie_to_magnum_dct()[source]

Method returning a mapping from ROXIE naming convention to MagNum naming convention. In case there is a field not present in ROXIE but present in MagNum, then its default value is None.

Returns:

a dictionary from ROXIE to MagNum names

name: str = ''
classmethod reorder_dct(dct: dict) → dict[source]

Method reordering an input dictionary to follow ROXIE ordering and magnum naming convention. The reason for this is the use of inheritance which does not follow the ROXIE ordering.

Parameters:

dct

Returns: