Skip to content

i_model_data

Module for IModelData interface

!!! interfaces IModelData

IModelData (ABC)

Interface for the model data

Source code in api/i_model_data.py 
class IModelData(ABC):
    """Interface for the model data"""

    @property
    @abstractmethod
    def name(self) -> str:
        """Name of the model"""

    @property
    @abstractmethod
    def version(self) -> List[int]:
        """Version of the model"""

    @property
    @abstractmethod
    def datasets(self) -> List[IDatasetData]:
        """Datasets of the model"""

    @property
    @abstractmethod
    def output_path(self) -> Path:
        """Model path to the output file"""

    @property
    @abstractmethod
    def output_variables(self) -> List[str]:
        """Output variables when a selection of output variables is made"""

    @property
    @abstractmethod
    def rules(self) -> List[IRuleData]:
        """Rules of the model"""

datasets: List[decoimpact.data.api.i_dataset.IDatasetData] property readonly

Datasets of the model

name: str property readonly

Name of the model

output_path: Path property readonly

Model path to the output file

output_variables: List[str] property readonly

Output variables when a selection of output variables is made

rules: List[decoimpact.data.api.i_rule_data.IRuleData] property readonly

Rules of the model

version: List[int] property readonly

Version of the model