Skip to content

results

EnDataFrame

Bases: BaseModel

Represents a data model for a DataFrame-like structure with enhanced time series data.

This class is designed to manage and store time series data associated with a specific name and a corresponding index of datetime values.

Attributes:

Name Type Description
name str

Name of the data frame.
index list[datetime]

List of datetime objects representing the index of the data frame.
data list[EnTimeSeries]

List of EnTimeSeries objects representing the time series data.
Source code in backend/app/results/model.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class EnDataFrame(BaseModel):
    """
    Represents a data model for a DataFrame-like structure with enhanced time series data.

    This class is designed to manage and store time series data associated with a specific
    name and a corresponding index of datetime values.

    :ivar name: Name of the data frame.
    :type name: str
    :ivar index: List of datetime objects representing the index of the data frame.
    :type index: list[datetime]
    :ivar data: List of EnTimeSeries objects representing the time series data.
    :type data: list[EnTimeSeries]
    """
    name: str
    index: list[datetime]
    data: list[EnTimeSeries]

EnTimeSeries

Bases: BaseModel

Represents a time series data model with a name and corresponding data points.

This class provides a structure for storing time series data which includes a descriptive name and a list of numerical data points. It can be used for various time-based data analysis and storage requirements.

Attributes:

Name Type Description
name str

The name of the time series.
data list[float]

A list of numerical data points representing the time series.
Source code in backend/app/results/model.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class EnTimeSeries(BaseModel):
    """
    Represents a time series data model with a name and corresponding data points.

    This class provides a structure for storing time series data which includes
    a descriptive name and a list of numerical data points. It can be used for
    various time-based data analysis and storage requirements.

    :ivar name: The name of the time series.
    :type name: str
    :ivar data: A list of numerical data points representing the time series.
    :type data: list[float]
    """
    name: str
    data: list[float]

ResultDataModel

Bases: GeneralDataModel

Represents a specialized data model for storing results.

Inherits from the GeneralDataModel and is used specifically for storing a collection of EnDataFrame objects. This class helps organize and manage the result data in a structured manner.

Attributes:

Name Type Description
items list[EnDataFrame]

A collection of EnDataFrame objects representing the data stored in the model.
Source code in backend/app/results/model.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
class ResultDataModel(GeneralDataModel):
    """
    Represents a specialized data model for storing results.

    Inherits from the `GeneralDataModel` and is used specifically
    for storing a collection of `EnDataFrame` objects. This class
    helps organize and manage the result data in a structured manner.

    :ivar items: A collection of `EnDataFrame` objects representing
        the data stored in the model.
    :type items: list[EnDataFrame]
    """
    items: list[EnDataFrame]