Lemma is an Electromagnetics API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

GridReader.h 2.6KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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. \ingroup LemmaCore
  23. \brief Abstract class for grid readers.
  24. \details Provides a consistent interface for reading grid files in Lemma.
  25. */
  26. class GridReader : public LemmaObject {
  27. friend std::ostream &operator << (std::ostream &stream, const GridReader &ob) {
  28. stream << ob.Serialize() << "\n---\n"; // End of doc --- as a direct stream should encapulste thingy
  29. return stream;
  30. }
  31. public:
  32. // ==================== LIFECYCLE =======================
  33. // ==================== OPERATORS =======================
  34. // ==================== OPERATIONS =======================
  35. virtual void ReadASCIIGridFile( const std::string& name )=0;
  36. virtual std::shared_ptr< Grid > GetGrid( )=0;
  37. // ==================== ACCESS =======================
  38. // ==================== INQUIRY =======================
  39. /** Returns the name of the underlying class, similiar to Python's type */
  40. virtual inline std::string GetName() const {
  41. return this->CName;
  42. }
  43. protected:
  44. // ==================== LIFECYCLE =======================
  45. /** Default protected constructor, use New */
  46. GridReader ( ) : LemmaObject( ) {
  47. }
  48. /** Default protected constructor, use New */
  49. GridReader ( const YAML::Node& node ) : LemmaObject( node ) {
  50. }
  51. /** Default protected constructor, use Delete */
  52. ~GridReader () {
  53. }
  54. private:
  55. /** ASCII string representation of the class name */
  56. static constexpr auto CName = "GridReader";
  57. // ==================== DATA MEMBERS =========================
  58. }; // ----- end of class GridReader -----
  59. } // ----- end of Lemma name -----
  60. #endif // ----- #ifndef GRIDREADER_INC -----