diff --git a/tracetools_analysis/tracetools_analysis/data_model/__init__.py b/tracetools_analysis/tracetools_analysis/data_model/__init__.py index 4b18865..c2744aa 100644 --- a/tracetools_analysis/tracetools_analysis/data_model/__init__.py +++ b/tracetools_analysis/tracetools_analysis/data_model/__init__.py @@ -11,3 +11,15 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. + +"""Base data model module.""" + + +class DataModel(): + """ + Container with pre-processed data for an analysis to use. + + Contains data for an analysis to use. This is a middleground between trace events data and the + output data of an analysis. It uses pandas `DataFrame` directly. + """ + pass diff --git a/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py b/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py index b7a1eeb..e11d531 100644 --- a/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py +++ b/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py @@ -16,12 +16,14 @@ import pandas as pd +from . import DataModel -class CpuTimeDataModel(): + +class CpuTimeDataModel(DataModel): """ Container to model pre-processed CPU time data for analysis. - Contains data for an analysis to use. It uses pandas DataFrames directly. + Contains every duration instance. """ def __init__(self) -> None: diff --git a/tracetools_analysis/tracetools_analysis/data_model/ros.py b/tracetools_analysis/tracetools_analysis/data_model/ros.py index a82ed3b..056d0a8 100644 --- a/tracetools_analysis/tracetools_analysis/data_model/ros.py +++ b/tracetools_analysis/tracetools_analysis/data_model/ros.py @@ -16,14 +16,14 @@ import pandas as pd +from . import DataModel -class RosDataModel(): + +class RosDataModel(DataModel): """ Container to model pre-processed ROS data for analysis. - Contains data for an analysis to use. This is a middleground between ROS userspace trace - events data and the output data of an analysis. This aims to represent the data in a - ROS-aware way. It uses pandas DataFrames directly. + This aims to represent the data in a ROS-aware way. """ def __init__(self) -> None: