Main Lemma Repository

GridReader.h 2.4KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. /* This file is part of Lemma, a geophysical modelling and inversion API */
  2. /* This Source Code Form is subject to the terms of the Mozilla Public
  3. * License, v. 2.0. If a copy of the MPL was not distributed with this
  4. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  5. */
  6. /**
  7. @file
  8. @date 09/23/2013 11:25:11 AM
  9. @version $Id$
  10. @author Trevor Irons (ti)
  11. @email Trevor.Irons@xri-geo.com
  12. @copyright Copyright (c) 2013, XRI Geophysics, LLC
  13. @copyright Copyright (c) 2013, Trevor Irons
  14. **/
  15. #ifndef GRIDREADER_INC
  16. #define GRIDREADER_INC
  17. #include "LemmaObject.h"
  18. #include "Grid.h"
  19. namespace Lemma {
  20. /**
  21. @class
  22. \brief Abstract class for grid readers.
  23. \details Provides a consistent interface for reading grid files in Lemma.
  24. */
  25. class GridReader : public LemmaObject {
  26. friend std::ostream &operator << (std::ostream &stream, const GridReader &ob) {
  27. stream << ob.Serialize() << "\n---\n"; // End of doc --- as a direct stream should encapulste thingy
  28. return stream;
  29. }
  30. public:
  31. // ==================== LIFECYCLE =======================
  32. // ==================== OPERATORS =======================
  33. // ==================== OPERATIONS =======================
  34. virtual void ReadASCIIGridFile( const std::string& name )=0;
  35. virtual std::shared_ptr< Grid > GetGrid( )=0;
  36. // ==================== ACCESS =======================
  37. // ==================== INQUIRY =======================
  38. /** Returns the name of the underlying class, similiar to Python's type */
  39. virtual inline std::string GetName() const {
  40. return this->CName;
  41. }
  42. protected:
  43. // ==================== LIFECYCLE =======================
  44. /** Default protected constructor, use New */
  45. GridReader ( ) : LemmaObject( ) {
  46. }
  47. /** Default protected constructor, use Delete */
  48. ~GridReader () {
  49. }
  50. private:
  51. /** ASCII string representation of the class name */
  52. static constexpr auto CName = "GridReader";
  53. // ==================== DATA MEMBERS =========================
  54. }; // ----- end of class GridReader -----
  55. } // ----- end of Lemma name -----
  56. #endif // ----- #ifndef GRIDREADER_INC -----