Lemma/Modules/LemmaCore/include/GridReader.h

/* This file is part of Lemma, a geophysical modelling and inversion API */

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

/**
  @file
  @date      09/23/2013 11:25:11 AM
  @version   $Id$
  @author    Trevor Irons (ti)
  @email     Trevor.Irons@xri-geo.com
  @copyright Copyright (c) 2013, XRI Geophysics, LLC
  @copyright Copyright (c) 2013, Trevor Irons
 **/

#ifndef  GRIDREADER_INC
#define  GRIDREADER_INC

#include "LemmaObject.h"
#include "Grid.h"

namespace Lemma {

    /**
      @class
      \ingroup LemmaCore
      \brief   Abstract class for grid readers.
      \details Provides a consistent interface for reading grid files in Lemma.
     */
    class GridReader : public LemmaObject {

        friend std::ostream &operator << (std::ostream &stream, const GridReader &ob) {
            stream << ob.Serialize()  << "\n---\n"; // End of doc --- as a direct stream should encapulste thingy
            return stream;
        }

        public:

            // ====================  LIFECYCLE     =======================

            // ====================  OPERATORS     =======================

            // ====================  OPERATIONS    =======================

            virtual void ReadASCIIGridFile( const std::string& name )=0;

            virtual std::shared_ptr< Grid > GetGrid( ) const =0;

            // ====================  ACCESS        =======================

            // ====================  INQUIRY       =======================

            /** Returns the name of the underlying class, similiar to Python's type */
            virtual std::string GetName() const = 0;

        protected:

            // ====================  LIFECYCLE     =======================

            /** Default protected constructor, use New */
            GridReader ( const ctor_key& key ) : LemmaObject( key ) {
            }

            /** Default protected constructor, use New */
            GridReader ( const YAML::Node& node, const ctor_key& key ) : LemmaObject( node, key ) {
            }

            /** Default protected constructor, use Delete */
            ~GridReader () {
            }

        private:

            /** ASCII string representation of the class name */
            static constexpr auto CName = "GridReader";

            // ====================  DATA MEMBERS  =========================

    }; // -----  end of class  GridReader  -----


}		// -----  end of Lemma  name  -----

#endif   // ----- #ifndef GRIDREADER_INC  -----