Merge pull request #1618 from SCIInstitute/split-up-headers

Big clean up of Module and Algo headers

Author: dcwhite

src/Core/Algorithms/Base/AlgorithmBase.cc

@@ -60,8 +60,6 @@ Name::Name(const std::string& name) : name_(name)
   }
 }
 
-AlgorithmBase::~AlgorithmBase() {}
-
 namespace
 {
   // Note: boost::serialization has trouble with NaN values, in addition to the platform differences.
@@ -381,10 +379,10 @@ bool AlgorithmParameterList::checkOption(const AlgorithmParameterName& key, cons
   return boost::iequals(value, currentValue);
 }
 
-void AlgorithmBase::dumpAlgoState() const
+void AlgorithmParameterList::dumpAlgoState() const
 {
   std::ostringstream ostr;
-  ostr << "Algorithm state for " << typeid(*this).name() << " id#" << id() << std::endl;
+  ostr << "Algorithm state for " << typeid(*this).name() << std::endl;
 
   auto range = std::make_pair(paramsBegin(), paramsEnd());
   BOOST_FOREACH(const ParameterMap::value_type& pair, range)
@@ -466,4 +464,4 @@ std::vector<std::string> Core::Algorithms::toNameVector(const Variable::List& li
 std::vector<double> Core::Algorithms::toDoubleVector(const Variable::List& list)
 {
   return toTypedVector<double>(list, [](const Variable& v) { return v.toDouble(); });
-}
+}

src/Core/Algorithms/Base/AlgorithmBase.h

@@ -39,15 +39,15 @@
 namespace SCIRun {
 namespace Core {
 namespace Algorithms {
-  
-  class SCISHARE AlgorithmBase : public AlgorithmInterface, public AlgorithmParameterList, public AlgorithmLogger, public AlgorithmStatusReporter
+
+  class SCISHARE AlgorithmBase :
+    public AlgorithmInterface,
+    public AlgorithmParameterList,
+    public AlgorithmLogger,
+    public AlgorithmStatusReporter
   {
-  public:
-    virtual ~AlgorithmBase();
-  protected:
-    void dumpAlgoState() const;
   };
-  
+
 }}}
 
 #endif

src/Core/Algorithms/Base/AlgorithmData.h

@@ -55,7 +55,7 @@ namespace Algorithms {
     {
       auto it = data_.find(name);
       /// @todo: log incorrect type if present but wrong type
-      return it == data_.end() ? boost::shared_ptr<T>() : boost::dynamic_pointer_cast<T>(it->second[0]);
+      return it == data_.end() ? nullptr : boost::dynamic_pointer_cast<T>(it->second[0]);
     }
 
     template <typename T>
@@ -81,11 +81,11 @@ namespace Algorithms {
     boost::any transient_;
   };
 
-  class SCISHARE AlgorithmInput : public AlgorithmData 
+  class SCISHARE AlgorithmInput : public AlgorithmData
   {
   public:
     AlgorithmInput() {}
-    AlgorithmInput(const Map& m) : AlgorithmData(m) {}
+    explicit AlgorithmInput(const Map& m) : AlgorithmData(m) {}
   };
 
   class SCISHARE AlgorithmOutput : public AlgorithmData
@@ -97,9 +97,9 @@ namespace Algorithms {
     VariableHandle additionalAlgoOutput_;
   };
 
-  typedef Datatypes::SharedPointer<AlgorithmInput> AlgorithmInputHandle;
-  typedef Datatypes::SharedPointer<AlgorithmOutput> AlgorithmOutputHandle;
-  
+  typedef SharedPointer<AlgorithmInput> AlgorithmInputHandle;
+  typedef SharedPointer<AlgorithmOutput> AlgorithmOutputHandle;
+
 }}}
 
 #endif

src/Core/Algorithms/Base/AlgorithmFwd.h

@@ -30,18 +30,19 @@
 #define ALGORITHMS_BASE_ALGORITHMFWD_H
 
 #include <Core/Datatypes/DatatypeFwd.h>
+#include <Core/Utils/SmartPointers.h>
 #include <Core/Algorithms/Base/share.h>
 
 namespace SCIRun {
 namespace Core {
 namespace Algorithms {
 
   class AlgorithmBase;
-  typedef Datatypes::SharedPointer<AlgorithmBase> AlgorithmHandle;
+  typedef SharedPointer<AlgorithmBase> AlgorithmHandle;
 
   class AlgorithmFactory;
-  typedef Datatypes::SharedPointer<AlgorithmFactory> AlgorithmFactoryHandle;
+  typedef SharedPointer<AlgorithmFactory> AlgorithmFactoryHandle;
 
 }}}
 
-#endif
+#endif

src/Core/Algorithms/Base/AlgorithmInterfaces.h

@@ -36,22 +36,11 @@
 namespace SCIRun {
 namespace Core {
 namespace Algorithms {
-  
+
   class SCISHARE AlgorithmInterface : public HasIntegerId
   {
   public:
     virtual ~AlgorithmInterface() {}
-    
-    /*
- @todo idea: make it mockable
-  
-    virtual OutputDatatypeHandleOptions run(InputDatatypeHandleOptions, ModuleParameterState) = 0;
-
-      ModuleParameterState: essentially a map of GuiVars. but need hooks for undo/redo and serialization
-      Input: tuple/heterogeneous vector of Datatypes
-      Output: tuple of Datatypes, possibly delay-executed
-    */
-
     virtual AlgorithmOutput run(const AlgorithmInput& input) const = 0;
   };
 

src/Core/Algorithms/Base/AlgorithmParameterList.h

@@ -73,10 +73,11 @@ namespace Algorithms {
     typedef std::map<AlgorithmParameterName, AlgorithmParameter> ParameterMap;
     ParameterMap::const_iterator paramsBegin() const { return parameters_.begin(); }
     ParameterMap::const_iterator paramsEnd() const { return parameters_.end(); }
+    void dumpAlgoState() const;
   private:
     ParameterMap parameters_;
   };
-  
+
 }}}
 
 #endif

src/Core/Algorithms/Base/AlgorithmStatusReporter.h

@@ -52,7 +52,7 @@ namespace Algorithms {
     virtual void update_progress(double percent) const
     {
       if (updaterFunc_)
-        updaterFunc_(percent); 
+        updaterFunc_(percent);
     }
 
     typedef boost::function<void(double)> UpdaterFunc;
@@ -72,6 +72,8 @@ namespace Algorithms {
     const AlgorithmStatusReporter* asr_;
   };
 
+  #define REPORT_STATUS(className) ScopedAlgorithmStatusReporter __asr(this, #className);
+
 }}}
 
 #endif

src/Core/Algorithms/Base/Variable.h

@@ -38,6 +38,7 @@
 #include <boost/iterator/counting_iterator.hpp>
 #endif
 #include <Core/Datatypes/DatatypeFwd.h>
+#include <Core/Algorithms/Base/AlgorithmFwd.h>
 #include <Core/Algorithms/Base/Name.h>
 #include <Core/Algorithms/Base/Option.h>
 #include <Core/Algorithms/Base/share.h>
@@ -49,16 +50,15 @@ namespace Algorithms {
   class SCISHARE Variable
   {
   public:
-    typedef std::vector<Variable> List;
-
-    typedef boost::variant<
+    using List = std::vector<Variable>;
+    using Value = boost::variant<
       int,
       double,
       std::string,
       bool,
       AlgoOption,
       List
-    > Value;
+    >;
 
     Variable() {}
     Variable(const Name& name, const Value& value);
@@ -109,7 +109,7 @@ namespace Algorithms {
   Variable::List makeNamedVariableList(const Name (&namesList)[N], Ts&&... params)
   {
     std::vector<Variable::Value> values{ params... };
-    
+
     auto namesIter = &namesList[0];
     Variable::List vars;
     std::transform(values.begin(), values.end(), std::back_inserter(vars),
@@ -139,7 +139,7 @@ namespace Algorithms {
 
   typedef Variable AlgorithmParameter;
   typedef Variable::List VariableList;
-  typedef Datatypes::SharedPointer<Variable> VariableHandle;
+  typedef SharedPointer<Variable> VariableHandle;
 
 }
 

src/Core/Algorithms/DataIO/Tests/ReadMatrixTests.cc

@@ -128,8 +128,6 @@ TEST(ReadMatrixAlgorithmTest, TestDenseFromRealASCIIMatFile)
     ASSERT_TRUE(matrixIs::dense(matrix));
 
     auto dense = castMatrix::toDense(matrix);
-    double* ptr = dense->data();
-    size_t size = dense->get_dense_size();
 
     EXPECT_EQ(4, dense->cols());
     EXPECT_EQ(3, dense->rows());