CMakeLists.txt

@@ -154,9 +154,9 @@ add_library(
     src/exseisdat/piol/configuration/ExSeisPIOL.cc
     src/exseisdat/piol/file/Input_file.cc
     src/exseisdat/piol/file/Input_file_segy.cc
-    src/exseisdat/piol/file/object/ObjectInterface.cc
-    src/exseisdat/piol/file/object/ObjectSEGY.cc
-    src/exseisdat/piol/file/object/ReadSEGYModel.cc
+    src/exseisdat/piol/file/detail/ObjectInterface.cc
+    src/exseisdat/piol/file/detail/ObjectSEGY.cc
+    src/exseisdat/piol/file/detail/ReadSEGYModel.cc
     src/exseisdat/piol/file/Output_file.cc
     src/exseisdat/piol/file/Output_file_segy.cc
     src/exseisdat/piol/io_driver/IO_driver_mpi.cc

doc/namespaces.dox

@@ -103,17 +103,6 @@
 ///
 
 ///
-<<<<<<< HEAD
-=======
-/// @namespace exseis::piol::file::object
-///
-/// @brief classes to.......
-///
-/// @todo document!
-///
-
-///
->>>>>>> b6d20c75c4294edab32b0cff7259765af98af594
 /// @namespace exseis::piol::io_driver
 ///
 /// @brief Interface and implementations that perform I/O operations

include/exseisdat/piol.hh

@@ -11,10 +11,10 @@
 #include "exseisdat/piol/file/Input_file_segy.hh"
 #include "exseisdat/piol/file/Output_file.hh"
 #include "exseisdat/piol/file/Output_file_segy.hh"
-#include "exseisdat/piol/file/object/Model3dInterface.hh"
-#include "exseisdat/piol/file/object/ObjectInterface.hh"
-#include "exseisdat/piol/file/object/ObjectSEGY.hh"
-#include "exseisdat/piol/file/object/ReadSEGYModel.hh"
+#include "exseisdat/piol/file/detail/Model3dInterface.hh"
+#include "exseisdat/piol/file/detail/ObjectInterface.hh"
+#include "exseisdat/piol/file/detail/ObjectSEGY.hh"
+#include "exseisdat/piol/file/detail/ReadSEGYModel.hh"
 #include "exseisdat/piol/io_driver/IO_driver.hh"
 #include "exseisdat/piol/io_driver/IO_driver_mpi.hh"
 #include "exseisdat/piol/makeFile.hh"

include/exseisdat/piol/file/Input_file.hh

@@ -8,7 +8,7 @@
 #define EXSEISDAT_PIOL_FILE_INPUT_FILE_HH
 
 #include "exseisdat/piol/configuration/ExSeisPIOL.hh"
-#include "exseisdat/piol/file/object/ObjectInterface.hh"
+#include "exseisdat/piol/file/detail/ObjectInterface.hh"
 #include "exseisdat/piol/metadata/Trace_metadata.hh"
 
 #include <memory>

include/exseisdat/piol/file/Input_file_segy.hh

@@ -6,7 +6,7 @@
 #define EXSEISDAT_PIOL_FILE_INPUT_FILE_SEGY_HH
 
 #include "exseisdat/piol/file/Input_file.hh"
-#include "exseisdat/piol/file/object/ObjectSEGY.hh"
+#include "exseisdat/piol/file/detail/ObjectSEGY.hh"
 #include "exseisdat/piol/segy/utils.hh"
 
 #include <cstdint>

include/exseisdat/piol/file/Output_file.hh

@@ -8,7 +8,7 @@
 #define EXSEISDAT_PIOL_FILE_OUTPUT_FILE_HH
 
 #include "exseisdat/piol/configuration/ExSeisPIOL.hh"
-#include "exseisdat/piol/file/object/ObjectInterface.hh"
+#include "exseisdat/piol/file/detail/ObjectInterface.hh"
 #include "exseisdat/piol/metadata/Trace_metadata.hh"
 
 #include <memory>

include/exseisdat/piol/file/object/Model3dInterface.hh → include/exseisdat/piol/file/detail/Model3dInterface.hh

@@ -4,8 +4,8 @@
 /// @details The \c Model3dInterface is a generic interface for reading 3d
 ///          volumetric seismic data.
 ////////////////////////////////////////////////////////////////////////////////
-#ifndef EXSEISDAT_PIOL_FILE_OBJECT_MODEL3DINTERFACE_HH
-#define EXSEISDAT_PIOL_FILE_OBJECT_MODEL3DINTERFACE_HH
+#ifndef EXSEISDAT_PIOL_FILE_DETAIL_MODEL3DINTERFACE_HH
+#define EXSEISDAT_PIOL_FILE_DETAIL_MODEL3DINTERFACE_HH
 
 #include "exseisdat/piol/operations/gather.hh"
 #include "exseisdat/utils/distributed_vector/Distributed_vector.hh"
@@ -97,4 +97,4 @@ class Model3dInterface {
 }  // namespace piol
 }  // namespace exseis
 
-#endif  // EXSEISDAT_PIOL_FILE_OBJECT_MODEL3DINTERFACE_HH
+#endif  // EXSEISDAT_PIOL_FILE_DETAIL_MODEL3DINTERFACE_HH

include/exseisdat/piol/file/object/ObjectInterface.hh → include/exseisdat/piol/file/detail/ObjectInterface.hh

@@ -4,8 +4,8 @@
 /// @details The Object layer interface is a base class which specific Obj
 ///          implementations work off.
 ////////////////////////////////////////////////////////////////////////////////
-#ifndef EXSEISDAT_PIOL_FILE_OBJECT_OBJECTINTERFACE_HH
-#define EXSEISDAT_PIOL_FILE_OBJECT_OBJECTINTERFACE_HH
+#ifndef EXSEISDAT_PIOL_FILE_DETAIL_OBJECTINTERFACE_HH
+#define EXSEISDAT_PIOL_FILE_DETAIL_OBJECTINTERFACE_HH
 
 #include "exseisdat/piol/configuration/ExSeisPIOL.hh"
 #include "exseisdat/piol/io_driver/IO_driver_mpi.hh"
@@ -230,4 +230,4 @@ class ObjectInterface {
 }  // namespace piol
 }  // namespace exseis
 
-#endif  // EXSEISDAT_PIOL_FILE_OBJECT_OBJECTINTERFACE_HH
+#endif  // EXSEISDAT_PIOL_FILE_DETAIL_OBJECTINTERFACE_HH

include/exseisdat/piol/file/object/ObjectSEGY.hh → include/exseisdat/piol/file/detail/ObjectSEGY.hh

@@ -6,10 +6,10 @@
 /// @brief The SEGY implementation of the Object layer interface
 /// @details The SEGY specific implementation of the Object layer interface
 ////////////////////////////////////////////////////////////////////////////////
-#ifndef EXSEISDAT_PIOL_FILE_OBJECT_OBJECTSEGY_HH
-#define EXSEISDAT_PIOL_FILE_OBJECT_OBJECTSEGY_HH
+#ifndef EXSEISDAT_PIOL_FILE_DETAIL_OBJECTSEGY_HH
+#define EXSEISDAT_PIOL_FILE_DETAIL_OBJECTSEGY_HH
 
-#include "exseisdat/piol/file/object/ObjectInterface.hh"
+#include "exseisdat/piol/file/detail/ObjectInterface.hh"
 #include "exseisdat/utils/types/typedefs.hh"
 
 namespace exseis {
@@ -125,4 +125,4 @@ class ObjectSEGY : public ObjectInterface {
 }  // namespace piol
 }  // namespace exseis
 
-#endif  // EXSEISDAT_PIOL_FILE_OBJECT_OBJECTSEGY_HH
+#endif  // EXSEISDAT_PIOL_FILE_DETAIL_OBJECTSEGY_HH

include/exseisdat/piol/file/object/ReadSEGYModel.hh → include/exseisdat/piol/file/detail/ReadSEGYModel.hh

@@ -2,11 +2,11 @@
 /// @file
 /// @brief The \c ReadSEGYModel class reads SEGY velocity models.
 ////////////////////////////////////////////////////////////////////////////////
-#ifndef EXSEISDAT_PIOL_FILE_OBJECT_READSEGYMODEL_HH
-#define EXSEISDAT_PIOL_FILE_OBJECT_READSEGYMODEL_HH
+#ifndef EXSEISDAT_PIOL_FILE_DETAIL_READSEGYMODEL_HH
+#define EXSEISDAT_PIOL_FILE_DETAIL_READSEGYMODEL_HH
 
 #include "exseisdat/piol/file/Input_file_segy.hh"
-#include "exseisdat/piol/file/object/Model3dInterface.hh"
+#include "exseisdat/piol/file/detail/Model3dInterface.hh"
 #include "exseisdat/utils/distributed_vector/Distributed_vector.hh"
 
 namespace exseis {
@@ -52,4 +52,4 @@ class ReadSEGYModel : public Model3dInterface, public Input_file_segy {
 }  // namespace piol
 }  // namespace exseis
 
-#endif  // EXSEISDAT_PIOL_FILE_OBJECT_READSEGYMODEL_HH
+#endif  // EXSEISDAT_PIOL_FILE_DETAIL_READSEGYMODEL_HH

include/exseisdat/piol/makeFile.hh

@@ -8,7 +8,7 @@
 #include "exseisdat/piol/file/Input_file.hh"
 #include "exseisdat/piol/file/Output_file.hh"
 
-#include "exseisdat/piol/file/object/ObjectInterface.hh"
+#include "exseisdat/piol/file/detail/ObjectInterface.hh"
 
 #include <memory>
 #include <string>

include/exseisdat/piol/metadata/Trace_metadata.hh

@@ -42,7 +42,7 @@ class Trace_metadata {
     /// @details A common cause for this being thrown is where the key exists in
     ///          the metadata structure, but the wrong type has been queried.
     ///          e.g. A floating point entry for that key exists, but an integer
-    ///             entry for the key is requested.
+    ///               entry for the key is requested.
     ///
     class Entry_not_found : public std::out_of_range {
         using out_of_range::out_of_range;

include/exseisdat/piol/operations/minmax.hh

@@ -140,7 +140,7 @@ std::vector<CoordElem> get_coord_min_max(
  *                      \c coord
  * @param[in]   ylam    The function for extracting the second parameter from
  *                      \c coord
- * @param[in] minmax    An array of length 4 with the CoordElem structure as
+ * @param[in]   minmax  An array of length 4 with the CoordElem structure as
  *                      elements.  min for xlam, max for xlam, min for ylam, max
  *                      for ylam.
  */

include/exseisdat/piol/operations/sort_operations/sort.hh

@@ -51,14 +51,14 @@ std::vector<size_t> get_sort_index(size_t sz, const size_t* list);
  *  Implementation note: the Trace_metadata vector is used internally to allow
  *  random-access iterator support.
  *
- *  @param[in]      piol    The PIOL object.
- *  @param[in,out]  prm     The parameter structure to sort
- *  @param[in]      comp    The Trace_metadata function to use for less-than
- *                          comparisons between objects in the vector. It
- *                          assumes each Trace_metadata structure has exactly
- *                          one entry.
- *  @param[in]   file_order Do we wish to have the sort in the sorted input
- *                          order (true) or sorted order (false)
+ *  @param[in]      piol        The PIOL object.
+ *  @param[in,out]  prm         The parameter structure to sort
+ *  @param[in]      comp        The Trace_metadata function to use for less-than
+ *                              comparisons between objects in the vector. It
+ *                              assumes each Trace_metadata structure has
+ *                              exactly one entry.
+ *  @param[in]      file_order  Do we wish to have the sort in the sorted input
+ *                              order (true) or sorted order (false)
  *
  *  @return Return the correct order of traces from those which are smallest
  *          with respect to the comp function.

include/exseisdat/piol/segy/utils.hh

@@ -149,6 +149,7 @@ exseis::utils::Floating_point parse_scalar(int16_t segy_scalar);
 ///
 /// Shown is the
 /// position of the least significant digit, \c d:
+/// @code
 /// -10000 - d0000.0000
 /// -1000  - d000.0000
 /// -100   - d00.0000
@@ -159,6 +160,7 @@ exseis::utils::Floating_point parse_scalar(int16_t segy_scalar);
 /// 100    - d.dd
 /// 1000   - d.ddd
 /// 10000  - d.dddd
+/// @endcode
 ///
 /// @todo Handle the annoying case of numbers at or around 2147483648 with a
 ///       decimal somewhere.

src/exseisdat/flow/detail/Radon_gather_state.cc

@@ -4,7 +4,7 @@
 
 #include "exseisdat/flow/detail/Radon_gather_state.hh"
 
-#include "exseisdat/piol/file/object/ReadSEGYModel.hh"
+#include "exseisdat/piol/file/detail/ReadSEGYModel.hh"
 
 using namespace exseis::piol;
 

src/exseisdat/piol/file/Input_file_segy.cc

@@ -9,7 +9,7 @@
 
 #include "exseisdat/piol/file/Input_file_segy.hh"
 
-#include "exseisdat/piol/file/object/ObjectSEGY.hh"
+#include "exseisdat/piol/file/detail/ObjectSEGY.hh"
 #include "exseisdat/piol/io_driver/IO_driver_mpi.hh"
 
 #include "exseisdat/piol/operations/sort_operations/sort.hh"

src/exseisdat/piol/file/Output_file_segy.cc

@@ -9,7 +9,7 @@
 
 #include "exseisdat/piol/file/Output_file_segy.hh"
 
-#include "exseisdat/piol/file/object/ObjectSEGY.hh"
+#include "exseisdat/piol/file/detail/ObjectSEGY.hh"
 #include "exseisdat/piol/io_driver/IO_driver_mpi.hh"
 #include "exseisdat/piol/segy/utils.hh"
 #include "exseisdat/utils/encoding/number_encoding.hh"

src/exseisdat/piol/file/detail/ObjectInterface.cc

+#include "exseisdat/piol/file/detail/ObjectInterface.hh"

src/exseisdat/piol/file/object/ObjectSEGY.cc → src/exseisdat/piol/file/detail/ObjectSEGY.cc

@@ -5,7 +5,7 @@
 ////////////////////////////////////////////////////////////////////////////////
 
 #include "exseisdat/piol/configuration/ExSeisPIOL.hh"
-#include "exseisdat/piol/file/object/ObjectSEGY.hh"
+#include "exseisdat/piol/file/detail/ObjectSEGY.hh"
 #include "exseisdat/piol/io_driver/IO_driver.hh"
 #include "exseisdat/piol/io_driver/IO_driver_mpi.hh"
 #include "exseisdat/piol/segy/utils.hh"