Refactor ExSeisPIOL
S-01717
As a ExSeisDat Developer I want the ExSeisPIOL refactored to have clearer interfaces and implementations so it is easier to maintain in the future.
Pre-Dev Notes:
ADDME
Implementation Notes:
ADDME
System Test Changes:
ADDME
Bug Fixes:
Likely Numerous
C++ API Changes:
Extensive - ExSeisUtils, ExSeisPIOL, ExSeisFlow Names of classes and functions changed, implementation details changed. Particularly the parameter structure.
C API Changes:
Extensive
C API definitions in mixed C/C++ headers have been split into a separate file. Where enums need to be accessed from C and C++, they've been copied in both files and a test added to ensure they match.
Success Criteria:
- Functions and classes not explicitly dependent on Parallel I/O of seismic data files should be moved into the ExSeisUtils library.
- Function / Class interfaces should be clear and self describing.
- A user should be able to guess what each function will do, ideally without reference to the documentation.
- The documentation should be fleshed out for each function.
- Function implementations should be as obvious as possible.
CREATED ON - 01/05/2018