Lemma is an Electromagnetics API
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

TEMInductiveReceiver.h 2.7KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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. /** Default protected constructor, use NewSP */
  31. explicit TEMInductiveReceiver (const ctor_key& key);
  32. /** Default protected constructor, use DeSerialize */
  33. TEMInductiveReceiver (const YAML::Node& node, const ctor_key& key);
  34. /** Default protected destructor */
  35. ~TEMInductiveReceiver ();
  36. /**
  37. * @copybrief LemmaObject::New()
  38. * @copydetails LemmaObject::New()
  39. */
  40. static std::shared_ptr<TEMInductiveReceiver> NewSP();
  41. /**
  42. * Uses YAML to serialize this object.
  43. * @return a YAML::Node
  44. */
  45. YAML::Node Serialize() const;
  46. /**
  47. * Constructs an object from a YAML::Node.
  48. */
  49. static std::shared_ptr<TEMInductiveReceiver> DeSerialize(const YAML::Node& node);
  50. // ==================== OPERATORS =======================
  51. // ==================== OPERATIONS =======================
  52. // ==================== ACCESS =======================
  53. // ==================== INQUIRY =======================
  54. /** Returns the name of the underlying class, similiar to Python's type */
  55. virtual std::string GetName() const {
  56. return this->CName;
  57. }
  58. protected:
  59. // ==================== LIFECYCLE =======================
  60. private:
  61. // ==================== DATA MEMBERS =========================
  62. static constexpr auto CName = "PolygonalWireAntenna";
  63. }; // ----- end of class TEMInductiveReceiver -----
  64. } // ----- end of Lemma name -----
  65. #endif // ----- #ifndef TEMINDUCTIVERECEIVER_INC -----