ModuleStateInterface Class Reference

#include <ModuleStateInterface.h>

Inheritance diagram for ModuleStateInterface:

Public Types
typedef std::vector < SCIRun::Core::Algorithms::AlgorithmParameterName >	Keys
typedef SCIRun::Core::Algorithms::AlgorithmParameterName	Name
typedef SCIRun::Core::Algorithms::AlgorithmParameter	Value
typedef boost::any	TransientValue
typedef boost::optional < TransientValue >	TransientValueOption
typedef boost::signals2::signal< void()>	state_changed_sig_t

Public Member Functions
virtual	~ModuleStateInterface ()
virtual const Value	getValue (const Name &name) const =0
virtual void	setValue (const Name &name, const SCIRun::Core::Algorithms::AlgorithmParameter::Value &value)=0
virtual bool	containsKey (const Name &name) const =0
virtual Keys	getKeys () const =0
virtual ModuleStateHandle	clone () const =0
virtual TransientValueOption	getTransientValue (const std::string &name) const =0
virtual void	setTransientValue (const std::string &name, const TransientValue &value, bool fireSignal)=0
virtual void	fireTransientStateChangeSignal ()=0
virtual boost::signals2::connection	connect_state_changed (state_changed_sig_t::slot_function_type subscriber)=0

Member Typedef Documentation

typedef std::vector<SCIRun::Core::Algorithms::AlgorithmParameterName> Keys

typedef SCIRun::Core::Algorithms::AlgorithmParameterName Name

typedef boost::signals2::signal<void()> state_changed_sig_t

typedef boost::any TransientValue

typedef boost::optional<TransientValue> TransientValueOption

typedef SCIRun::Core::Algorithms::AlgorithmParameter Value

Constructor & Destructor Documentation

~ModuleStateInterface ( )

virtual

Member Function Documentation

virtual ModuleStateHandle clone ( ) const

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual boost::signals2::connection connect_state_changed ( state_changed_sig_t::slot_function_type  subscriber )

pure virtual

Implemented in NullModuleState, and SimpleMapModuleState.

virtual bool containsKey ( const Name &  name ) const

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual void fireTransientStateChangeSignal ( )

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual Keys getKeys ( ) const

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual TransientValueOption getTransientValue ( const std::string &  name ) const

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual const Value getValue ( const Name &  name ) const

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual void setTransientValue ( const std::string &  name, const TransientValue &  value, bool  fireSignal  )

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

virtual void setValue ( const Name &  name, const SCIRun::Core::Algorithms::AlgorithmParameter::Value &  value  )

pure virtual

Implemented in SimpleMapModuleState, and NullModuleState.

---

The documentation for this class was generated from the following files:

• Dataflow/Network/ModuleStateInterface.h
• Dataflow/Network/ModuleStateInterface.cc