ModuleInterface Class Reference

#include <ModuleInterface.h>

Inheritance diagram for ModuleInterface:

Public Types
enum	ExecutionState { Waiting, Executing, Completed }

Public Member Functions
virtual	~ModuleInterface ()
virtual ModuleStateHandle	get_state ()=0
virtual void	do_execute ()=0
virtual ExecutionState	executionState () const =0
virtual void	setExecutionState (ExecutionState state)=0
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 =0
virtual SCIRun::Core::Algorithms::AlgorithmStatusReporter::UpdaterFunc	getUpdaterFunc () const =0
virtual void	setUpdaterFunc (SCIRun::Core::Algorithms::AlgorithmStatusReporter::UpdaterFunc func)=0
virtual void	setUiToggleFunc (UiToggleFunc func)=0
virtual void	preDestruction ()
virtual bool	needToExecute () const =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
Public Member Functions inherited from ModuleInfoProvider
virtual	~ModuleInfoProvider ()
virtual bool	hasOutputPort (const PortId &id) const =0
virtual OutputPortHandle	getOutputPort (const PortId &id) const =0
virtual std::vector < OutputPortHandle >	findOutputPortsWithName (const std::string &name) const =0
virtual size_t	num_output_ports () const =0
virtual std::vector < OutputPortHandle >	outputPorts () const =0
virtual bool	hasInputPort (const PortId &id) const =0
virtual InputPortHandle	getInputPort (const PortId &id) const =0
virtual std::vector < InputPortHandle >	findInputPortsWithName (const std::string &name) const =0
virtual size_t	num_input_ports () const =0
virtual std::vector < InputPortHandle >	inputPorts () const =0
virtual std::string	get_module_name () const =0
virtual ModuleId	get_id () const =0
virtual bool	has_ui () const =0
virtual const ModuleLookupInfo &	get_info () const =0
virtual bool	hasDynamicPorts () const =0
Public Member Functions inherited from ModuleDisplayInterface
virtual	~ModuleDisplayInterface ()
virtual void	setUiVisible (bool visible)=0
Public Member Functions inherited from ExecutableObject
	~ExecutableObject ()
virtual void	execute ()=0
virtual boost::signals2::connection	connectExecuteBegins (const ExecuteBeginsSignalType::slot_type &subscriber)=0
virtual boost::signals2::connection	connectExecuteEnds (const ExecuteEndsSignalType::slot_type &subscriber)=0
virtual boost::signals2::connection	connectErrorListener (const ErrorSignalType::slot_type &subscriber)=0
Public Member Functions inherited from AlgorithmCollaborator
virtual	~AlgorithmCollaborator ()

Detailed Description

Todo:

: interface is getting bloated, segregate it.

Member Enumeration Documentation

enum ExecutionState

Enumerator
Waiting
Executing
Completed

Constructor & Destructor Documentation

~ModuleInterface ( )

virtual

Member Function Documentation

virtual void addPortConnection ( const boost::signals2::connection &  con )

pure virtual

Implemented in Module.

virtual void do_execute ( )

pure virtual

Implemented in Module.

virtual ExecutionState executionState ( ) const

pure virtual

Implemented in Module.

virtual std::vector<SCIRun::Core::Datatypes::DatatypeHandleOption> get_dynamic_input_handles ( const PortId &  id )

pure virtual

virtual SCIRun::Core::Datatypes::DatatypeHandleOption get_input_handle ( const PortId &  id )

pure virtual

virtual ModuleStateHandle get_state ( )

pure virtual

Implemented in Module.

virtual Core::Algorithms::AlgorithmHandle getAlgorithm ( ) const

pure virtual

Implemented in Module.

virtual SCIRun::Core::Logging::LoggerHandle getLogger ( ) const

pure virtual

Implements AlgorithmCollaborator.

Implemented in Module.

virtual SCIRun::Core::Algorithms::AlgorithmStatusReporter::UpdaterFunc getUpdaterFunc ( ) const

pure virtual

Todo:

functions

Implements AlgorithmCollaborator.

Implemented in Module.

virtual bool needToExecute ( ) const

pure virtual

Todo:

:

Implemented in Module.

virtual void portAddedSlot ( const Networks::ModuleId &  mid, const Networks::PortId &  pid  )

inlinevirtual

Reimplemented in InsertFieldsIntoBundle.

virtual void portRemovedSlot ( const Networks::ModuleId &  mid, const Networks::PortId &  pid  )

inlinevirtual

Reimplemented in ModuleWithAsyncDynamicPorts, and InsertFieldsIntoBundle.

virtual void preDestruction ( )

inlinevirtual

Todo:

: name too clunky. Called before the module is to be destroyed. More importantly, called before the UI widget is to be destroyed.

virtual void send_output_handle ( const PortId &  id, SCIRun::Core::Datatypes::DatatypeHandle  data  )

pure virtual

virtual void set_id ( const std::string &  id )

pure virtual

Todo:

for deserialization

Implemented in Module.

virtual void set_state ( ModuleStateHandle  state )

pure virtual

Implemented in Module.

virtual void setExecutionState ( ExecutionState  state )

pure virtual

virtual void setLogger ( SCIRun::Core::Logging::LoggerHandle  log )

pure virtual

Implemented in Module.

virtual void setStateDefaults ( )

pure virtual

Implemented in DummyModule, SolveMinNormLeastSqSystem, ShowFieldModule, CreateLatVol, ViewScene, CreateFieldData, DynamicPortTester, ElectrodeCoilSetupModule, CalculateSignedDistanceToField, AlignMeshBoundingBoxes, CalculateGradients, ConvertQuadSurfToTriSurf, GetDomainBoundary, GetFieldBoundary, JoinFields, GenerateROIStatisticsModule, SetupRHSforTDCSandTMSModule, ReadFieldModule, TDCSSimulatorModule, CalculateFieldData, SetFieldNodes, AppendMatrixModule, SendTestMatrixModule, WriteFieldModule, GetFieldsFromBundle, GetMatricesFromBundle, InsertFieldsIntoBundle, InsertMatricesIntoBundle, GetFieldNodes, EvaluateLinearAlgebraUnaryModule, CreateStringModule, PrintDatatypeModule, ReceiveScalarModule, ReceiveTestMatrixModule, SendScalarModule, SetConductivitiesToTetMeshModule, ReadMatrixModule, WriteMatrixModule, CreateScalarFieldDataBasic, ReportFieldInfoModule, ApplyMappingMatrixModule, BuildMappingMatrix, CalculateDistanceToField, CalculateDistanceToFieldBoundary, CalculateVectorMagnitudesModule, CollectFields, ConvertFieldBasis, ConvertFieldDataType, FairMesh, GetFieldDataModule, MapFieldDataFromElemToNodeModule, MapFieldDataFromNodeToElemModule, MapFieldDataOntoElements, MapFieldDataOntoNodes, ProjectPointsOntoMesh, RegisterWithCorrespondences, ResampleRegularMesh, ScaleFieldMeshAndData, SetFieldDataModule, SetFieldOrMeshStringProperty, SplitFieldByDomain, CreateMatrixModule, EvaluateLinearAlgebraBinaryModule, ReportMatrixInfoModule, SolveLinearSystemModule, CreateBasicColorMap, MatrixAsVectorFieldModule, AsyncPortTestModule, BuildFEMatrix, BuildTDCSMatrix, AddKnownsToLinearSystem, ConvertMatrixTypeModule, SelectSubMatrixModule, InterfaceWithCleaverModule, and GetSubmatrix.

virtual void setUiToggleFunc ( UiToggleFunc  func )

pure virtual

Implemented in Module.

virtual void setUpdaterFunc ( SCIRun::Core::Algorithms::AlgorithmStatusReporter::UpdaterFunc  func )

pure virtual

Implemented in Module.

---

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

• Dataflow/Network/ModuleInterface.h
• Dataflow/Network/ModuleInterface.cc