SimpleSourceSink.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2012 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.
*/

/// @todo Documentation Dataflow/Network/SimpleSourceSink.h

#ifndef DATAFLOW_NETWORK_SIMPLESOURCESINK_H
#define DATAFLOW_NETWORK_SIMPLESOURCESINK_H

#include <Dataflow/Network/DataflowInterfaces.h>
#include <Dataflow/Network/share.h>

namespace SCIRun
{
  namespace Dataflow
  {
    namespace Networks
    {
      class SCISHARE SimpleSink : public DatatypeSinkInterface
      {
      public:
        SimpleSink();
        virtual void waitForData();
        virtual SCIRun::Core::Datatypes::DatatypeHandleOption receive();
        virtual bool hasData() const { return hasData_; }
        virtual void setHasData(bool dataPresent);
        virtual DatatypeSinkInterface* clone() const;
        virtual bool hasChanged() const;
        void setData(SCIRun::Core::Datatypes::DatatypeHandle data);
        virtual boost::signals2::connection connectDataHasChanged(const DataHasChangedSignalType::slot_type& subscriber);
      private:
        SCIRun::Core::Datatypes::DatatypeHandle data_;
        SCIRun::Core::Datatypes::Datatype::id_type previousId_;
        bool hasData_;
        DataHasChangedSignalType dataHasChanged_;
      };
    
      /*
      IDEA

      // hook this up to SinkFactory. Executor needs a hook as well, to clearAllSinks.
      class SinkCacheManager
      {
        void addSink(Sink, sinkId); //adds to map
         void clearAllSinks();  // foreach sink in map, calls setHasData(false), unless cache flag is on
         void setCached(int SinkId, bool cache) // set cache flag for specified sink
      };
      
      
      */

      class SCISHARE SimpleSource : public DatatypeSourceInterface
      {
      public:
        virtual void send(DatatypeSinkInterfaceHandle receiver, SCIRun::Core::Datatypes::DatatypeHandle data);
      };
    }
  }
}

#endif