From 208511038bd1be74131e5dd2e4dfcb66780ce26d Mon Sep 17 00:00:00 2001
From: Christophe Bedard <fixed-term.christophe.bourquebedard@de.bosch.com>
Date: Mon, 29 Jul 2019 09:49:53 +0200
Subject: [PATCH] Move data models to new subdirectory

---
 .../analysis/data_model/__init__.py                 | 13 +++++++++++++
 .../analysis/{data_model.py => data_model/ros.py}   | 12 ++++++------
 .../tracetools_analysis/analysis/ros2_processor.py  |  6 +++---
 .../tracetools_analysis/analysis/utils.py           |  8 ++++----
 4 files changed, 26 insertions(+), 13 deletions(-)
 create mode 100644 tracetools_analysis/tracetools_analysis/analysis/data_model/__init__.py
 rename tracetools_analysis/tracetools_analysis/analysis/{data_model.py => data_model/ros.py} (96%)

diff --git a/tracetools_analysis/tracetools_analysis/analysis/data_model/__init__.py b/tracetools_analysis/tracetools_analysis/analysis/data_model/__init__.py
new file mode 100644
index 0000000..4b18865
--- /dev/null
+++ b/tracetools_analysis/tracetools_analysis/analysis/data_model/__init__.py
@@ -0,0 +1,13 @@
+# Copyright 2019 Robert Bosch GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
diff --git a/tracetools_analysis/tracetools_analysis/analysis/data_model.py b/tracetools_analysis/tracetools_analysis/analysis/data_model/ros.py
similarity index 96%
rename from tracetools_analysis/tracetools_analysis/analysis/data_model.py
rename to tracetools_analysis/tracetools_analysis/analysis/data_model/ros.py
index d9814f1..1fae54d 100644
--- a/tracetools_analysis/tracetools_analysis/analysis/data_model.py
+++ b/tracetools_analysis/tracetools_analysis/analysis/data_model/ros.py
@@ -12,18 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module for data model."""
+"""Module for ROS data model."""
 
 import pandas as pd
 
 
-class DataModel():
+class RosDataModel():
     """
-    Container to model pre-processed data for analysis.
+    Container to model pre-processed ROS data for analysis.
 
-    Contains data for an analysis to use. This is a middleground between 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.
+    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.
     """
 
     def __init__(self) -> None:
diff --git a/tracetools_analysis/tracetools_analysis/analysis/ros2_processor.py b/tracetools_analysis/tracetools_analysis/analysis/ros2_processor.py
index 47b6dea..3944669 100644
--- a/tracetools_analysis/tracetools_analysis/analysis/ros2_processor.py
+++ b/tracetools_analysis/tracetools_analysis/analysis/ros2_processor.py
@@ -19,7 +19,7 @@ from typing import List
 
 from tracetools_read.utils import get_field
 
-from .data_model import DataModel
+from .data_model.ros import RosDataModel
 from .handler import EventHandler
 from .lttng_models import EventMetadata
 
@@ -63,12 +63,12 @@ class Ros2Processor(EventHandler):
         }
         super().__init__(handler_map)
 
-        self._data = DataModel()
+        self._data = RosDataModel()
 
         # Temporary buffers
         self._callback_instances = {}
 
-    def get_data_model(self) -> DataModel:
+    def get_data_model(self) -> RosDataModel:
         return self._data
 
     def _handle_rcl_init(
diff --git a/tracetools_analysis/tracetools_analysis/analysis/utils.py b/tracetools_analysis/tracetools_analysis/analysis/utils.py
index ef637c8..8ed5348 100644
--- a/tracetools_analysis/tracetools_analysis/analysis/utils.py
+++ b/tracetools_analysis/tracetools_analysis/analysis/utils.py
@@ -21,17 +21,17 @@ from typing import Union
 
 from pandas import DataFrame
 
-from .data_model import DataModel
+from .data_model.ros import RosDataModel
 
 
-class DataModelUtil():
+class RosDataModelUtil():
     """
     Data model utility class.
 
-    Provides functions to get info on a data model.
+    Provides functions to get info on a ROS data model.
     """
 
-    def __init__(self, data_model: DataModel) -> None:
+    def __init__(self, data_model: RosDataModel) -> None:
         """
         Constructor.