Updated for TEM1D, including skeleton testing framework.

Documentation/Doxyfile.in

@@ -858,7 +858,7 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           = ./unittest \
+EXAMPLE_PATH           = ./Modules/examples/ \
                          ./
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
@@ -2178,7 +2178,7 @@ DOT_NUM_THREADS        = 0
 # The default value is: Helvetica.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_FONTNAME           = FreeSans
+DOT_FONTNAME           = Helvetica 
 
 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
 # dot graphs.

Modules/LemmaCore/testing/SerializeCheck.h

@@ -10,7 +10,6 @@
 /**
  * @file
  * @date      06/16/2016 09:12:46 PM
- * @version   $Id$
  * @author    Trevor Irons (ti)
  * @email     tirons@egi.utah.edu
  * @copyright Copyright (c) 2016, University of Utah

Modules/TEM1D/CMakeLists.txt

@@ -27,6 +27,8 @@ install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma
 #install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/  FILES_MATCHING PATTERN "FDEM1D")
 #install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/FDEM1D  FILES_MATCHING PATTERN "*.h")
 
+install ( FILES include/TEM1D  DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma ) 
+
 # Examples
 if (LEMMA_BUILD_EXAMPLES)
 	add_subdirectory(examples)

Modules/TEM1D/include/TEM1D

@@ -0,0 +1,7 @@
+#pragma once
+
+#include "TEMTransmitter.h"
+#include "TEMReceiver.h"
+
+/* vim: set tabstop=4 expandtab: */
+/* vim: set filetype=cpp: */

Modules/TEM1D/include/TEMReceiver.h

@@ -11,7 +11,7 @@
  * @file
  * @date      10/08/2014 02:36:47 PM
  * @author    Trevor Irons (ti)
- * @email     Trevor.Irons@Utah.edu
+ * @email     Trevor.Irons@lemmasoftware.org
  * @copyright Copyright (c) 2014, Trevor Irons
  */
 #pragma once
@@ -30,8 +30,8 @@
 namespace Lemma {
 
 /**
-  \brief
-  \details
+  \brief   Describes a TEM receiver
+  \details A general class for TEM receivers
  */
 class TEMReceiver : public FieldPoints {
 
@@ -122,19 +122,6 @@ class TEMReceiver : public FieldPoints {
 
     // ====================  INQUIRY       =======================
 
-     #ifdef HAVE_YAMLCPP
-	/**
-     *  Uses YAML to serialize this object.
-     *  @return a YAML::Node
-     */
-    YAML::Node Serialize() const;
-
-    /**
-     *   Constructs an object from a YAML::Node.
-     */
-    static TEMReceiver* DeSerialize(const YAML::Node& node);
-     #endif
-
     /**
      * @return centre point of gates in sec
      */
@@ -150,6 +137,11 @@ class TEMReceiver : public FieldPoints {
      */
     Real    GetReferenceTime();
 
+    /** Returns the name of the underlying class, similiar to Python's type */
+    virtual std::string GetName() const {
+        return this->CName;
+    }
+
     protected:
 
     // ====================  LIFECYCLE     =======================
@@ -162,6 +154,9 @@ class TEMReceiver : public FieldPoints {
 
     private:
 
+    /** ASCII string representation of the class name */
+    static constexpr auto CName = "TEMReceiver";
+
     // ====================  DATA MEMBERS  =========================
 
     Real            moment;

Modules/TEM1D/include/TEMTransmitter.h

@@ -10,10 +10,8 @@
 /**
  * @file
  * @date      09/29/2014 11:43:17 AM
- * @version   $Id$
  * @author    Trevor Irons (ti)
- * @email     Trevor.Irons@xri-geo.com
- * @copyright Copyright (c) 2014, XRI Geophysics, LLC
+ * @email     Trevor.Irons@lemmasoftware.org
  * @copyright Copyright (c) 2014, Trevor Irons
  */
 
@@ -22,17 +20,12 @@
 
 #include "PolygonalWireAntenna.h"
 
-#ifdef HAVE_YAMLCPP
-#include "yaml-cpp/yaml.h"
-#endif
-
 namespace Lemma {
 
 /**
-  \brief   Describes a TEM pulse sequence
-  \details Flexible class desribing a pulse sequence used by
-           a TEM instruement. Can be used by Airborne or Ground
-           instruments.
+  \brief   Describes a TEM transmitter
+  \details Flexible class desribing a source used by TEM instrument.
+           Can be used by Airborne or Ground instruments.
  */
 class TEMTransmitter : public PolygonalWireAntenna {
 
@@ -42,22 +35,29 @@ class TEMTransmitter : public PolygonalWireAntenna {
 
     // ====================  LIFECYCLE     =======================
 
+    /** Default protected constructor, use New */
+    explicit TEMTransmitter (const ctor_key& );
+
+    /** Default protected constructor, use New */
+    TEMTransmitter (const YAML::Node& node, const ctor_key& );
+
+    /** Default protected destructor, use Delete */
+    ~TEMTransmitter ();
+
     /**
      * @copybrief LemmaObject::New()
      * @copydetails LemmaObject::New()
      */
-    static TEMTransmitter* New();
+    static std::shared_ptr<TEMTransmitter> NewSP();
 
     /**
      *  Performs a deep copy of this and returns pointer
      */
-    TEMTransmitter* Clone();
+    std::shared_ptr<TEMTransmitter> Clone();
 
-    /**
-     *  @copybrief   LemmaObject::Delete()
-     *  @copydetails LemmaObject::Delete()
-     */
-    void Delete();
+    YAML::Node Serialize() const;
+
+    static std::shared_ptr<TEMTransmitter> DeSerialize(const YAML::Node& node);
 
     // ====================  OPERATORS     =======================
 
@@ -71,6 +71,8 @@ class TEMTransmitter : public PolygonalWireAntenna {
 
     void SetWaveform( const VectorXr& times, const VectorXr& amps, const TIMEUNITS& units );
 
+    // ====================  INQUIRY       =======================
+
     /**
      *  @return the waveform times in seconds
      */
@@ -80,36 +82,19 @@ class TEMTransmitter : public PolygonalWireAntenna {
      */
     VectorXr GetWfmAmps();
 
-    // ====================  INQUIRY       =======================
-
-#ifdef HAVE_YAMLCPP
-    YAML::Node Serialize() const;
-    static TEMTransmitter* DeSerialize(const YAML::Node& node);
-#endif
+    /** Returns the name of the underlying class, similiar to Python's type */
+    virtual std::string GetName() const {
+        return this->CName;
+    }
 
     protected:
 
     // ====================  LIFECYCLE     =======================
 
-    /** Default protected constructor, use New */
-    TEMTransmitter (const std::string& name);
-
-#ifdef HAVE_YAMLCPP
-    /** Default protected constructor, use New */
-    TEMTransmitter (const YAML::Node& node);
-#endif
-
-    /** Default protected destructor, use Delete */
-    ~TEMTransmitter ();
-
-    /**
-     *  @copybrief   LemmaObject::Release()
-     *  @copydetails LemmaObject::Release()
-     */
-    void Release();
-
     private:
 
+    static constexpr auto CName = "TEMTransmitter";
+
     // ====================  DATA MEMBERS  =========================
 
     Real                    repFreq;

Modules/TEM1D/src/TEMTransmitter.cpp

@@ -23,24 +23,10 @@ namespace Lemma {
 
 // ====================  FRIEND METHODS  =====================
 
-#ifdef HAVE_YAMLCPP
 std::ostream &operator << (std::ostream &stream, const TEMTransmitter &ob) {
-    stream << ob.Serialize()  << "\n---\n"; // End of doc --- as a direct stream should encapulste thingy
+    stream << ob.Serialize()  << "\n";
     return stream;
 }
-// TODO CONSIDER INPUT OPERATOR TOO!
-//std::ostream &operator << (std::ostream &stream, const TEMTransmitter &ob) {
-//    stream << ob.Serialize()  << "\n---\n"; // End of doc --- as a direct stream should encapulste thingy
-//    return stream;
-//}
-#else
-std::ostream &operator << (std::ostream &stream, const TEMTransmitter &ob) {
-    stream << *(PolygonalWireAntenna*)(&ob);
-    stream << "YOU SHOULD COMPILE WITH YAML-CPP\n";
-    return stream;
-}
-#endif
-
 
 // ====================  LIFECYCLE     =======================
 
@@ -49,36 +35,34 @@ std::ostream &operator << (std::ostream &stream, const TEMTransmitter &ob) {
 //      Method:  TEMTransmitter
 // Description:  constructor (protected)
 //--------------------------------------------------------------------------------------
-TEMTransmitter::TEMTransmitter (const std::string& name) : PolygonalWireAntenna(name),
-    repFreq(0), repFreqUnits(HZ) {
+TEMTransmitter::TEMTransmitter (const ctor_key& key) :
+    PolygonalWireAntenna(key), repFreq(0), repFreqUnits(HZ)
+{
 
 }  // -----  end of method TEMTransmitter::TEMTransmitter  (constructor)  -----
 
-#ifdef HAVE_YAMLCPP
 //--------------------------------------------------------------------------------------
 //       Class:  TEMTransmitter
 //      Method:  TEMTransmitter
 // Description:  Deserializing constructor (protected)
 //--------------------------------------------------------------------------------------
-TEMTransmitter::TEMTransmitter (const YAML::Node& node) : PolygonalWireAntenna(node) {
-
+TEMTransmitter::TEMTransmitter (const YAML::Node& node, const ctor_key& key) :
+        PolygonalWireAntenna(node, key)
+{
     repFreq =  node["repFreq"].as<Real>();
     repFreqUnits =  string2Enum<FREQUENCYUNITS>( node["repFreqUnits"].as<std::string>() );
     wfmTimes = node["wfmTimes"].as<VectorXr>();
     wfmTimes = node["wfmAmps"].as<VectorXr>();
 
 }  // -----  end of method TEMTransmitter::TEMTransmitter  (constructor)  -----
-#endif
 
 //--------------------------------------------------------------------------------------
 //       Class:  TEMTransmitter
 //      Method:  New()
 // Description:  public constructor
 //--------------------------------------------------------------------------------------
-TEMTransmitter* TEMTransmitter::New() {
-    TEMTransmitter*  Obj = new TEMTransmitter("TEMTransmitter");
-    Obj->AttachTo(Obj);
-    return Obj;
+std::shared_ptr<TEMTransmitter> TEMTransmitter::NewSP() {
+    return std::make_shared<TEMTransmitter>( ctor_key() );
 }
 
 
@@ -86,8 +70,8 @@ TEMTransmitter* TEMTransmitter::New() {
 //       Class:  TEMTransmitter
 //      Method:  Clone
 //--------------------------------------------------------------------------------------
-TEMTransmitter* TEMTransmitter::Clone (  ) {
-    TEMTransmitter* copy = TEMTransmitter::New();
+std::shared_ptr<TEMTransmitter> TEMTransmitter::Clone (  ) {
+    auto copy = TEMTransmitter::NewSP();
     //copy->AttachTo(copy); // NO! Attached above!
 	copy->NumberOfPoints = this->NumberOfPoints;
 	copy->Freqs = this->Freqs;
@@ -116,32 +100,12 @@ TEMTransmitter::~TEMTransmitter () {
 
 //--------------------------------------------------------------------------------------
 //       Class:  TEMTransmitter
-//      Method:  Delete
-// Description:  public destructor
-//--------------------------------------------------------------------------------------
-void TEMTransmitter::Delete() {
-    this->DetachFrom(this);
-}
-
-//--------------------------------------------------------------------------------------
-//       Class:  TEMTransmitter
-//      Method:  Release
-// Description:  destructor (protected)
-//--------------------------------------------------------------------------------------
-void TEMTransmitter::Release() {
-    delete this;
-}
-
-//--------------------------------------------------------------------------------------
-//       Class:  TEMTransmitter
 //      Method:  Serialize
 //--------------------------------------------------------------------------------------
-#ifdef HAVE_YAMLCPP
 YAML::Node TEMTransmitter::Serialize (  ) const {
 
     YAML::Node node = PolygonalWireAntenna::Serialize();
-        // or we could do just like below. Same basic uglyness
-        node.SetTag( this->Name) ; //((PolygonalWireAntenna*)(&ob))->GetName() );
+        node.SetTag( this->GetName() );
         //node["address"] =  ss.str();
 
         node["repFreq"]      = this->repFreq;
@@ -156,13 +120,12 @@ YAML::Node TEMTransmitter::Serialize (  ) const {
 //       Class:  TEMTransmitter
 //      Method:  DeSerialize
 //--------------------------------------------------------------------------------------
-TEMTransmitter* TEMTransmitter::DeSerialize ( const  YAML::Node& node  ) {
-    TEMTransmitter* Object = new TEMTransmitter(node);
-    Object->AttachTo(Object);
-    DESERIALIZECHECK( node, Object )
-    return  Object;
+std::shared_ptr<TEMTransmitter> TEMTransmitter::DeSerialize ( const  YAML::Node& node  ) {
+    if (node.Tag() != "TEMTransmitter") {
+        throw  DeSerializeTypeMismatch( "TEMTransmitter", node.Tag());
+    }
+    return std::make_shared<TEMTransmitter> ( node, ctor_key() );
 }		// -----  end of method TEMTransmitter::DeSerialize  -----
-#endif
 
     // ====================  INQUIRY       =======================
 

Modules/TEM1D/testing/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+include_directories( ${CXXTEST_INCLUDE_DIR} )
+
+CXXTEST_ADD_TEST(unittest_TEM1D_GetNameCheck GetNameCheck.cc ${CMAKE_CURRENT_SOURCE_DIR}/GetNameCheck.h)
+target_link_libraries(unittest_TEM1D_GetNameCheck "lemmacore" "fdem1d" "tem1d")
+
+CXXTEST_ADD_TEST(unittest_TEM1D_SerializeCheck SerializeCheck.cc ${CMAKE_CURRENT_SOURCE_DIR}/SerializeCheck.h)
+target_link_libraries(unittest_TEM1D_SerializeCheck "lemmacore" "fdem1d" "tem1d")

Modules/TEM1D/testing/GetNameCheck.h

@@ -0,0 +1,42 @@
+/* This file is part of Lemma, a geophysical modelling and inversion API.
+ * More information is available at http://lemmasoftware.org
+ */
+
+/* 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      10/16/2018 12:46:43 PM
+ * @version   $Id$
+ * @author    Trevor Irons (ti)
+ * @email     Trevor.Irons@utah.edu
+ * @copyright Copyright (c) 2018, University of Utah
+ * @copyright Copyright (c) 2018, Lemma Software, LLC
+ */
+
+#include <cxxtest/TestSuite.h>
+#include <TEM1D>
+
+using namespace Lemma;
+
+class MyTestSuite : public CxxTest::TestSuite
+{
+    public:
+
+    void testTEMTransmitter( void )
+    {
+        auto Obj = TEMTransmitter::NewSP();
+        TS_ASSERT_EQUALS( Obj->GetName(), std::string("TEMTransmitter") );
+    }
+
+    void testTEMReceiver( void )
+    {
+        auto Obj = TEMReceiver::NewSP();
+        TS_ASSERT_EQUALS( Obj->GetName(), std::string("TEMReceiver") );
+    }
+
+};
+

Modules/TEM1D/testing/SerializeCheck.h

@@ -0,0 +1,56 @@
+/* This file is part of Lemma, a geophysical modelling and inversion API.
+ * More information is available at http://lemmasoftware.org
+ */
+
+/* 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      10/16/2018 12:43:19 PM
+ * @version   $Id$
+ * @author    Trevor Irons (ti)
+ * @email     Trevor.Irons@utah.edu
+ * @copyright Copyright (c) 2018, University of Utah
+ * @copyright Copyright (c) 2018, Lemma Software, LLC
+ */
+
+#include <cxxtest/TestSuite.h>
+#include <TEM1D>
+
+using namespace Lemma;
+
+class MyTestSuite : public CxxTest::TestSuite
+{
+    public:
+
+//     void test_trace(void)
+//     {
+//         TS_TRACE("This is a test tracing message.");
+//     }
+//
+//     void test_warn(void)
+//     {
+//         TS_WARN("This is a test warning message.");
+//     }
+
+    void testTEMTransmitter( void )
+    {
+        auto Obj = TEMTransmitter::NewSP();
+        YAML::Node node = Obj->Serialize();
+        auto Obj2 = TEMTransmitter::DeSerialize(node);
+        TS_ASSERT_EQUALS( Obj->GetName(), Obj2->GetName() );
+    }
+
+    void testTEMReceiver( void )
+    {
+        auto Obj = TEMReceiver::NewSP();
+        YAML::Node node = Obj->Serialize();
+        auto Obj2 = TEMReceiver::DeSerialize(node);
+        TS_ASSERT_EQUALS( Obj->GetName(), Obj2->GetName() );
+    }
+
+
+};