Closes #1597

Author: dcwhite

src/Dataflow/Network/CMakeLists.txt

@@ -71,6 +71,7 @@ SET(Dataflow_Network_HEADERS
   NetworkSettings.h
   NullModuleState.h
   Port.h
+  PortNames.h
   PortInterface.h
   PortManager.h
   share.h

src/Dataflow/Network/Module.cc

@@ -339,15 +339,15 @@ size_t Module::num_output_ports() const
 //TODO requirements for state metadata reporting
 std::string Module::stateMetaInfo() const
 {
-  if (!get_state())
+  if (!cstate())
     return "Null state map.";
-  auto keys = get_state()->getKeys();
+  auto keys = cstate()->getKeys();
   size_t i = 0;
   std::ostringstream ostr;
   ostr << "\n\t{";
   for (const auto& key : keys)
   {
-    ostr << "[" << key.name() << ", " << get_state()->getValue(key).value() << "]";
+    ostr << "[" << key.name() << ", " << cstate()->getValue(key).value() << "]";
     i++;
     if (i < keys.size())
       ostr << ",\n\t";
@@ -481,7 +481,7 @@ ModuleStateHandle Module::get_state()
   return impl_->state_;
 }
 
-const ModuleStateHandle Module::get_state() const
+const ModuleStateHandle Module::cstate() const
 {
   return impl_->state_;
 }
@@ -842,6 +842,8 @@ ModuleExecutionState& Module::executionState()
   return *impl_->executionState_;
 }
 
+/// @todo:
+// need to hook up output ports for cached state.
 bool Module::needToExecute() const
 {
   static Mutex needToExecuteLock("needToExecute");
@@ -1053,7 +1055,7 @@ std::string ModuleLevelUniqueIDGenerator::generateModuleLevelUniqueID(const Modu
   }
 
   toHash << "}__State{";
-  auto state = module.get_state();
+  auto state = module.cstate();
   for (const auto& key : state->getKeys())
   {
     toHash << key << "->" << state->getValue(key).value() << "_";

src/Dataflow/Network/Module.h

@@ -46,50 +46,13 @@
 #include <Dataflow/Network/ModuleDescription.h>
 #include <Dataflow/Network/PortManager.h>
 #include <Dataflow/Network/DefaultModuleFactories.h>
+#include <Dataflow/Network/PortNames.h>
 #include <Dataflow/Network/share.h>
 
 namespace SCIRun {
 namespace Dataflow {
 namespace Networks {
 
-
-      template <class Type, size_t N>
-      struct PortNameBase
-      {
-        explicit PortNameBase(const PortId& id) : id_(id) {}
-
-        operator PortId() const
-        {
-          return toId();
-        }
-
-        PortId toId() const
-        {
-          if (id_.name.empty())
-            BOOST_THROW_EXCEPTION(DataPortException() << SCIRun::Core::ErrorMessage("Port name not initialized!"));
-          return id_;
-        }
-        operator std::string() const
-        {
-          return toId().name;
-        }
-
-        PortId id_;
-      };
-
-      template <class Type, size_t N>
-      struct StaticPortName : PortNameBase<Type,N>
-      {
-        explicit StaticPortName(const PortId& id = PortId(0, "[not defined yet]")) : PortNameBase<Type,N>(id) {}
-      };
-
-      template <class Type, size_t N>
-      struct DynamicPortName : PortNameBase<Type,N>
-      {
-        explicit DynamicPortName(const PortId& id = PortId(0, "[not defined yet]")) : PortNameBase<Type,N>(id) {}
-      };
-
-
   class SCISHARE Module : public ModuleInterface,
     public Core::Logging::LegacyLoggerInterface,
     public StateChangeObserver,
@@ -105,7 +68,7 @@ namespace Networks {
 
     /*** User-interface ****/
     ModuleStateHandle get_state() override final;
-    const ModuleStateHandle get_state() const override final;
+    const ModuleStateHandle cstate() const override final;
     void enqueueExecuteAgain(bool upstream) override final;
     void error(const std::string& msg) const override final;
     void warning(const std::string& msg) const override final { getLogger()->warning(msg); }

src/Dataflow/Network/ModuleInterface.h

@@ -46,64 +46,64 @@ namespace SCIRun {
 namespace Dataflow {
 namespace Networks {
 
-  /// @todo: interface is getting bloated, segregate it.
-  class SCISHARE ModuleInterface : public ModuleInfoProvider, public ModuleDisplayInterface,
-    public ExecutableObject, public Core::Algorithms::AlgorithmCollaborator
+  // Methods a module writer needs to know/use/override
+  class SCISHARE ModuleUserInterface
   {
   public:
-    virtual ~ModuleInterface();
-
-    virtual ModuleStateHandle get_state() = 0;
-    virtual const ModuleStateHandle get_state() const = 0;
+    virtual ~ModuleUserInterface() {}
 
+    // These two functions must be implemented:
     virtual void execute() = 0;
+    virtual void setStateDefaults() = 0;
+
+    // These two functions must be understood and used correctly:
+    virtual ModuleStateHandle get_state() = 0;
+    virtual bool needToExecute() const = 0;
+  };
 
+  // Methods for internal developer use/testing
+  class SCISHARE ModuleInternalsInterface
+  {
+  public:
+    virtual ~ModuleInternalsInterface() {}
+    virtual const ModuleStateHandle cstate() const = 0;
     typedef boost::signals2::signal<void(bool)> ExecutionSelfRequestSignalType;
     virtual boost::signals2::connection connectExecuteSelfRequest(const ExecutionSelfRequestSignalType::slot_type& subscriber) = 0;
-
     virtual ModuleExecutionState& executionState() = 0;
-
     /// @todo for deserialization
     virtual void set_id(const std::string& id) = 0;
     virtual void set_state(ModuleStateHandle state) = 0;
-
     virtual SCIRun::Core::Datatypes::DatatypeHandleOption get_input_handle(const PortId& id) = 0;
     virtual std::vector<SCIRun::Core::Datatypes::DatatypeHandleOption> get_dynamic_input_handles(const PortId& id) = 0;
     virtual void send_output_handle(const PortId& id, SCIRun::Core::Datatypes::DatatypeHandle data) = 0;
-
     virtual void setLogger(SCIRun::Core::Logging::LoggerHandle log) = 0;
-    virtual SCIRun::Core::Logging::LoggerHandle getLogger() const override = 0;
-
-    /// @todo functions
-    virtual SCIRun::Core::Algorithms::AlgorithmStatusReporter::UpdaterFunc getUpdaterFunc() const override = 0;
     virtual void setUpdaterFunc(SCIRun::Core::Algorithms::AlgorithmStatusReporter::UpdaterFunc func) = 0;
     virtual void setUiToggleFunc(UiToggleFunc func) = 0;
-
-    /// @todo:
-    // need to hook up output ports for cached state.
-    virtual bool needToExecute() const = 0;
-
     virtual ModuleReexecutionStrategyHandle getReexecutionStrategy() const = 0;
     virtual void setReexecutionStrategy(ModuleReexecutionStrategyHandle caching) = 0;
-
-    virtual void setStateDefaults() = 0;
-
     virtual Core::Algorithms::AlgorithmHandle getAlgorithm() const = 0;
-
     virtual void portAddedSlot(const Networks::ModuleId& mid, const Networks::PortId& pid) {}
     virtual void portRemovedSlot(const Networks::ModuleId& mid, const Networks::PortId& pid) {}
     virtual void addPortConnection(const boost::signals2::connection& con) = 0;
-
     virtual void enqueueExecuteAgain(bool upstream) = 0;
-
     virtual const MetadataMap& metadata() const = 0;
-
     virtual bool isStoppable() const = 0;
-
     virtual bool executionDisabled() const = 0;
     virtual void setExecutionDisabled(bool disable) = 0;
   };
 
+  class SCISHARE ModuleInterface :
+    public ModuleUserInterface,
+    public ModuleInternalsInterface,
+    public ModuleInfoProvider,
+    public ModuleDisplayInterface,
+    public ExecutableObject,
+    public Core::Algorithms::AlgorithmCollaborator
+  {
+  public:
+    virtual ~ModuleInterface();
+  };
+
 }}}
 
 #endif

src/Dataflow/Network/PortNames.h

@@ -0,0 +1,83 @@
+/*
+   For more information, please see: http://software.sci.utah.edu
+
+   The MIT License
+
+   Copyright (c) 2015 Scientific Computing and Imaging Institute,
+   University of Utah.
+
+   License for the specific language governing rights and limitations under
+   Permission is hereby granted, free of charge, to any person obtaining a
+   copy of this software and associated documentation files (the "Software"),
+   to deal in the Software without restriction, including without limitation
+   the rights to use, copy, modify, merge, publish, distribute, sublicense,
+   and/or sell copies of the Software, and to permit persons to whom the
+   Software is furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included
+   in all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+   DEALINGS IN THE SOFTWARE.
+*/
+
+#ifndef DATAFLOW_NETWORK_PORTNAMES_H
+#define DATAFLOW_NETWORK_PORTNAMES_H
+
+#include <boost/noncopyable.hpp>
+#include <boost/static_assert.hpp>
+#include <Dataflow/Network/NetworkFwd.h>
+#include <Dataflow/Network/ModuleInterface.h>
+#include <Dataflow/Network/ModuleStateInterface.h>
+#include <Dataflow/Network/ModuleDescription.h>
+#include <Dataflow/Network/PortManager.h>
+#include <Dataflow/Network/share.h>
+
+namespace SCIRun {
+namespace Dataflow {
+namespace Networks {
+
+  template <class Type, size_t N>
+  struct PortNameBase
+  {
+    explicit PortNameBase(const PortId& id) : id_(id) {}
+
+    operator PortId() const
+    {
+      return toId();
+    }
+
+    PortId toId() const
+    {
+      if (id_.name.empty())
+        BOOST_THROW_EXCEPTION(DataPortException() << SCIRun::Core::ErrorMessage("Port name not initialized!"));
+      return id_;
+    }
+    operator std::string() const
+    {
+      return toId().name;
+    }
+
+    PortId id_;
+  };
+
+  template <class Type, size_t N>
+  struct StaticPortName : PortNameBase<Type,N>
+  {
+    explicit StaticPortName(const PortId& id = PortId(0, "[not defined yet]")) : PortNameBase<Type,N>(id) {}
+  };
+
+  template <class Type, size_t N>
+  struct DynamicPortName : PortNameBase<Type,N>
+  {
+    explicit DynamicPortName(const PortId& id = PortId(0, "[not defined yet]")) : PortNameBase<Type,N>(id) {}
+  };
+
+}}}
+
+#endif

src/Dataflow/Network/Tests/MockModule.h

@@ -47,7 +47,7 @@ namespace SCIRun {
           MOCK_METHOD0(execute, void());
           MOCK_METHOD0(executeWithSignals, bool());
           MOCK_METHOD0(get_state, ModuleStateHandle());
-          MOCK_CONST_METHOD0(get_state, const ModuleStateHandle());
+          MOCK_CONST_METHOD0(cstate, const ModuleStateHandle());
           MOCK_METHOD1(set_state, void(ModuleStateHandle));
           MOCK_METHOD2(send_output_handle, void(const PortId&, SCIRun::Core::Datatypes::DatatypeHandle));
           MOCK_METHOD1(get_input_handle, SCIRun::Core::Datatypes::DatatypeHandleOption(const PortId&));

src/Modules/DataIO/ReadMatrixClassic.cc

@@ -83,7 +83,7 @@ ReadMatrix::execute()
 
 bool ReadMatrix::useCustomImporter(const std::string& filename) const
 {
-  auto filetypename = get_state()->getValue(Variables::FileTypeName).toString();
+  auto filetypename = cstate()->getValue(Variables::FileTypeName).toString();
   return !(filetypename.empty() || filetypename == "SCIRun Matrix File" || filetypename == "SCIRun Matrix File (*.mat)");
 }
 

src/Modules/DataIO/WriteField.cc

@@ -117,7 +117,7 @@ void WriteField::execute()
 
 bool WriteField::useCustomExporter(const std::string& filename) const
 {
-  auto ft = get_state()->getValue(Variables::FileTypeName).toString();
+  auto ft = cstate()->getValue(Variables::FileTypeName).toString();
   LOG_DEBUG("WriteField with filetype " << ft);
   auto ret = boost::filesystem::extension(filename) != ".fld";
 

src/Modules/DataIO/WriteMatrix.cc

@@ -104,7 +104,7 @@ void WriteMatrix::execute()
 
 bool WriteMatrix::useCustomExporter(const std::string& filename) const
 {
-  auto ft = get_state()->getValue(Variables::FileTypeName).toString();
+  auto ft = cstate()->getValue(Variables::FileTypeName).toString();
   LOG_DEBUG("WriteMatrix with filetype " << ft);
 
   filetype_ = (ft == "SCIRun Matrix ASCII") ? "ASCII" : "Binary";

src/Modules/Legacy/Fields/ConvertFieldBasis.cc

@@ -95,7 +95,7 @@ ConvertFieldBasis::execute()
   }
 }
 
-void ConvertFieldBasis::pushInputFieldInfo(FieldHandle input) const
+void ConvertFieldBasis::pushInputFieldInfo(FieldHandle input)
 {
   auto state = get_state();
   std::string name = input->properties().get_name();