Skip to content

Enumerations

Source

Enum that defines the Plexos Schema.

name: str

Table name associated with this schema element.

Returns

  • str The underlying table name parsed from the enum value.
label: str | None

Primary label column name for the schema element, if any.

Returns

  • str | None The label column used as a default identifier when available.

Source

Enum that defines the different Plexos classes.

Full reference: ClassEnum.

Source

plexos_class_mapping = {enum_member.name: enum_member.value for enum_member in ClassEnum}

Source

Enum that defines the different Plexos colections via Collection Name.

Full reference: CollectionEnum.

Source

PLEXOS solve phases used in result table names.

Full reference: PhaseEnum.

Source

PLEXOS result periods used in result table names.

Full reference: PeriodEnum.

Source

DuckDB information_schema table types used by solution results.

Full reference: TableTypeEnum.

Source

Convert string to enum.

str2enum(string: str, schema_enum: type[Enum]=Schema) -> Schema | None

Source

Return default collection for class.

get_default_collection(class_enum: ClassEnum) -> CollectionEnum

Source

Parse a string or ClassEnum to a ClassEnum instance.

parse_class_enum(value: str | ClassEnum) -> ClassEnum

Source

Parse a string or CollectionEnum to a CollectionEnum instance.

parse_collection_enum(value: str | CollectionEnum) -> CollectionEnum