fgen.data_models.module_enum_defining

Data model of a module that defines an enum

EnumValue

class EnumValue(description, str_value, integer_value)

Bases: object

Data model of an enum value

description: str

Description of the value

integer_value: int

The integer value of the enum.

Ensures consistency across Python and Fortran.

str_value: str

The string value of the enum.

EnumDefinition

class EnumDefinition(name, description, values)

Bases: object

Data model of an enum definition

description: str

Description of enum

name: str

Name of the enum (in both Fortran and Python)

values: tuple[fgen.data_models.module_enum_defining.EnumValue, ...]

Values the enum can take

ModuleEnumDefining

class ModuleEnumDefining(name, description, provides)

Bases: object

Data model of a module that defines an enum

description: str

Description of the module

name: str

Name of the module

provides: fgen.data_models.module_enum_defining.EnumDefinition

Enum that this module defines