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.

Instrument.h 2.0KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. @file
  7. @author Trevor Irons
  8. @date 02/05/2010
  9. @version $Id: instrument.h 193 2014-11-10 23:51:41Z tirons $
  10. **/
  11. #ifndef __INSTRUMENT_H
  12. #define __INSTRUMENT_H
  13. #include "LemmaObject.h"
  14. namespace Lemma {
  15. // =======================================================================
  16. // Class: Instrument
  17. /// \ingroup LemmaCore
  18. /// \brief Abstract class for instruments
  19. /// \details
  20. // =======================================================================
  21. class Instrument : public LemmaObject {
  22. friend std::ostream &operator<<(std::ostream &stream,
  23. const Instrument &ob);
  24. public:
  25. // ==================== LIFECYCLE ===========================
  26. // ==================== OPERATORS ===========================
  27. // ==================== OPERATIONS ===========================
  28. //virtual void ForwardModelOnOctreeMesh()=0;
  29. // ==================== ACCESS ===========================
  30. // ==================== INQUIRY ===========================
  31. /** Returns the name of the underlying class, similiar to Python's type */
  32. virtual inline std::string GetName() const {
  33. return this->CName;
  34. }
  35. // ==================== DATA MEMBERS ===========================
  36. protected:
  37. // ==================== LIFECYCLE ===========================
  38. /// Default protected constructor.
  39. Instrument ( );
  40. /// Default protected constructor.
  41. ~Instrument ();
  42. private:
  43. /** ASCII string representation of the class name */
  44. static constexpr auto CName = "Instrument";
  45. }; // ----- end of class Instrument -----
  46. } // ----- end of Lemma name -----
  47. #endif // __INSTRUMENT_H