Merge pull request #345 from JeffersonLab/nbrei_deprecate_jmetadata

Deprecate JMetadata
JeffersonLab · Aug 21, 2024 · c5674aa · c5674aa
2 parents b65ac3c + 96c17e8
commit c5674aa
Show file tree

Hide file tree

Showing 15 changed files with 5 additions and 458 deletions.
diff --git a/docs/howto/other-howtos.md b/docs/howto/other-howtos.md
@@ -11,7 +11,6 @@ Table of contents
 6.  [Benchmark a JANA program](benchmarking.html)
 4.  [Generate code skeletons](#creating-code-skeletons) for projects, plugins, components, etc
 5.  [Run the JANA Status/Control/Debugger GUI](#run-the-status-control-debugger-gui)
-6.  [Work with factory metadata](#using-factory-metadata) for collecting statistics, etc
 7.  Create a service which can be shared between different plugins
 8.  Handle both real and simulated data
 9.  Handle EPICS data
@@ -232,26 +231,6 @@ The JANA Status/Control/Debugger GUI can be a useful tool for probing a running
 be found on the [dedicated page for the GUI](GUI_Monitor_Debug.md)
 
 
-Using factory metadata
-----------------------
-
-The `JFactoryT<T>` interface abstracts the creation logic for a vector of n objects of type `T`. However, often
-we also care about single pieces of data associated with the same computation. For instance, a track fitting factory
-might want to return statistics about how many fits succeeded and failed. 
-
-A naive solution is to put member variables on the factory and then access them from a `JEventProcessor` 
-by obtaining the `JFactoryT<T>` via `GetFactory<>` and performing a dynamic cast to the underlying factory type. 
-Although this works, it means that that factory can no longer be swapped with an alternate version without modifying
-the calling code. This degrades the whole project's ability to take advantage of the plugin architecture and hurts 
-its overall code quality.
-
-Instead, we recommend using the `JMetadata` template trait. Each `JFactoryT<T>` not only produces a vector of `T`, 
-but also a singular `JMetadata<T>` struct whose contents can be completely arbitrary, but cannot be redefined for a
-particular T. All `JFactoryT<T>` for some `T` will use it. 
-
-An example project demonstrating usage of JMetadata can be found under `examples/MetadataExample`. 
-
-
 
 
 

diff --git a/src/examples/CMakeLists.txt b/src/examples/CMakeLists.txt
@@ -3,7 +3,6 @@ add_subdirectory(DstExample)
 add_subdirectory(Tutorial)
 add_subdirectory(StreamingExample)
 add_subdirectory(EventGroupExample)
-add_subdirectory(MetadataExample)
 add_subdirectory(SubeventExample)
 add_subdirectory(SubeventCUDAExample)
 add_subdirectory(UnitTestingExample)

diff --git a/src/examples/MetadataExample/CMakeLists.txt b/src/examples/MetadataExample/CMakeLists.txt
diff --git a/src/examples/MetadataExample/MetadataAggregator.cc b/src/examples/MetadataExample/MetadataAggregator.cc
diff --git a/src/examples/MetadataExample/MetadataAggregator.h b/src/examples/MetadataExample/MetadataAggregator.h
diff --git a/src/examples/MetadataExample/MetadataExample.cc b/src/examples/MetadataExample/MetadataExample.cc
diff --git a/src/examples/MetadataExample/README.md b/src/examples/MetadataExample/README.md
diff --git a/src/examples/MetadataExample/RandomTrackSource.cc b/src/examples/MetadataExample/RandomTrackSource.cc
diff --git a/src/examples/MetadataExample/RandomTrackSource.h b/src/examples/MetadataExample/RandomTrackSource.h
diff --git a/src/examples/MetadataExample/Track.h b/src/examples/MetadataExample/Track.h