Main Lemma Repository

TEMInductiveReceiver.h 2.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. /* This file is part of Lemma, a geophysical modelling and inversion API.
  2. * More information is available at http://lemmasoftware.org
  3. */
  4. /* This Source Code Form is subject to the terms of the Mozilla Public
  5. * License, v. 2.0. If a copy of the MPL was not distributed with this
  6. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  7. */
  8. /**
  9. * @file
  10. * @date 10/08/2014 03:17:52 PM
  11. * @version $Id$
  12. * @author Trevor Irons (ti)
  13. * @email Trevor.Irons@xri-geo.com
  14. * @copyright Copyright (c) 2014, XRI Geophysics, LLC
  15. * @copyright Copyright (c) 2014, Trevor Irons
  16. */
  17. #ifndef TEMINDUCTIVERECEIVER_INC
  18. #define TEMINDUCTIVERECEIVER_INC
  19. #include "TEMReceiver.h"
  20. namespace Lemma {
  21. /**
  22. \brief Derived class of TEMReceiver.
  23. \details An inductive receiver, measures dB/dt
  24. */
  25. class TEMInductiveReceiver : public TEMReceiver {
  26. friend std::ostream &operator<<(std::ostream &stream,
  27. const TEMInductiveReceiver &ob);
  28. public:
  29. // ==================== LIFECYCLE =======================
  30. /**
  31. * @copybrief LemmaObject::New()
  32. * @copydetails LemmaObject::New()
  33. */
  34. static TEMInductiveReceiver* New();
  35. /**
  36. * @copybrief LemmaObject::Delete()
  37. * @copydetails LemmaObject::Delete()
  38. */
  39. void Delete();
  40. // ==================== OPERATORS =======================
  41. // ==================== OPERATIONS =======================
  42. // ==================== ACCESS =======================
  43. // ==================== INQUIRY =======================
  44. #ifdef HAVE_YAMLCPP
  45. /**
  46. * Uses YAML to serialize this object.
  47. * @return a YAML::Node
  48. */
  49. YAML::Node Serialize() const;
  50. /**
  51. * Constructs an object from a YAML::Node.
  52. */
  53. static TEMInductiveReceiver* DeSerialize(const YAML::Node& node);
  54. #endif
  55. protected:
  56. // ==================== LIFECYCLE =======================
  57. /** Default protected constructor, use New */
  58. TEMInductiveReceiver (const std::string& name);
  59. #ifdef HAVE_YAMLCPP
  60. /** Default protected constructor, use New */
  61. TEMInductiveReceiver (const YAML::Node& node);
  62. #endif
  63. /** Default protected destructor, use Delete */
  64. ~TEMInductiveReceiver ();
  65. /**
  66. * @copybrief LemmaObject::Release()
  67. * @copydetails LemmaObject::Release()
  68. */
  69. void Release();
  70. private:
  71. // ==================== DATA MEMBERS =========================
  72. }; // ----- end of class TEMInductiveReceiver -----
  73. } // ----- end of Lemma name -----
  74. #endif // ----- #ifndef TEMINDUCTIVERECEIVER_INC -----