update documentation custom data example

Signed-off-by: Bryce Ferenczi <[email protected]>
5had3z · Aug 14, 2024 · 2098619 · 2098619
1 parent 578f423
commit 2098619
Showing 1 changed file with 20 additions and 4 deletions.
diff --git a/docs/custom_dataset.rst b/docs/custom_dataset.rst
@@ -19,25 +19,41 @@ Serialized Database
 
     namespace cvt {
 
+    struct EntryMeta {
+        std::string location;
+        float some_property;
+    };
+
     struct MyDatasetEntry {
-        ReplayInfo header;
+        using header_type = EntryMeta;
+
+        EntryMeta header;
         std::vector<float> timeseriesA;
         std::vector<float> timeseriesB;
     };
 
     template<> struct DatabaseInterface<MyDatasetEntry> {
 
-        static auto getHeaderImpl(std::istream &dbStream) -> ReplayInfo
+        static auto getHeaderImpl(std::istream &dbStream) -> EntryMeta
         {
-            ReplayInfo result;
+            EntryMeta result;
             deserialize(result, dbStream);
             return result;
-        };
+        }
+
+        static auto getEntryImpl(std::istream &dbStream) -> MyDatasetEntry
+        {
+            MyDatasetEntry data;
+            deserialize(data, dbStream);
+            return data;
+        }
 
         // Implement other methods
 
     };
 
+    using CustomDatabase = ReplayDatabase<MyDatasetEntry>;
+
     } // namespace cvt