Make an LatVolField that fits the source field. More...

#include <CreateLatVol.h>

Inheritance diagram for CreateLatVol:

Public Member Functions
	CreateLatVol ()

virtual void	execute ()

virtual void	setStateDefaults ()

	INPUT_PORT (0, InputField, LegacyField)

	INPUT_PORT (1, LatVolSize, DenseMatrix)

	OUTPUT_PORT (0, OutputField, LegacyField)

Public Member Functions inherited from Module
	Module (const ModuleLookupInfo &info, bool hasUi=true, Core::Algorithms::AlgorithmFactoryHandle algoFactory=defaultAlgoFactory_, ModuleStateFactoryHandle stateFactory=defaultStateFactory_, const std::string &version="1.0")

virtual	~Module ()

std::string	get_module_name () const

std::string	get_categoryname () const

std::string	get_packagename () const

ModuleId	get_id () const

virtual const ModuleLookupInfo &	get_info () const

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

bool	has_ui () const

void	setUiVisible (bool visible)

virtual size_t	num_input_ports () const

virtual size_t	num_output_ports () const

virtual bool	hasInputPort (const PortId &id) const

virtual bool	hasOutputPort (const PortId &id) const

virtual InputPortHandle	getInputPort (const PortId &id) const

virtual OutputPortHandle	getOutputPort (const PortId &id) const

virtual std::vector < InputPortHandle >	findInputPortsWithName (const std::string &name) const

virtual std::vector < OutputPortHandle >	findOutputPortsWithName (const std::string &name) const

virtual std::vector < InputPortHandle >	inputPorts () const

virtual std::vector < OutputPortHandle >	outputPorts () const

virtual void	do_execute () throw ()

virtual ModuleStateHandle	get_state ()

virtual const ModuleStateHandle	get_state () const

virtual void	set_state (ModuleStateHandle state)

virtual ExecutionState	executionState () const

virtual void	setExecutionState (ExecutionState state)

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

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

virtual void	error (const std::string &msg) const

virtual void	warning (const std::string &msg) const

virtual void	remark (const std::string &msg) const

virtual void	status (const std::string &msg) const

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

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

virtual void	setUiToggleFunc (UiToggleFunc func)

virtual boost::signals2::connection	connectExecuteBegins (const ExecuteBeginsSignalType::slot_type &subscriber)

virtual boost::signals2::connection	connectExecuteEnds (const ExecuteEndsSignalType::slot_type &subscriber)

virtual boost::signals2::connection	connectErrorListener (const ErrorSignalType::slot_type &subscriber)

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

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

virtual bool	needToExecute () const

virtual bool	hasDynamicPorts () const

bool	oport_connected (const PortId &id) const

template<class T , size_t N>
boost::shared_ptr< T >	getRequiredInput (const StaticPortName< T, N > &port)

template<class T , size_t N>
boost::optional < boost::shared_ptr< T > >	getOptionalInput (const StaticPortName< T, N > &port)

template<class T , size_t N>
std::vector< boost::shared_ptr < T > >	getRequiredDynamicInputs (const DynamicPortName< T, N > &port)

template<class T , size_t N>
std::vector< boost::shared_ptr < T > >	getOptionalDynamicInputs (const DynamicPortName< T, N > &port)

template<class T , class D , size_t N>
void	sendOutput (const StaticPortName< T, N > &port, boost::shared_ptr< D > data)

template<class T , size_t N>
void	sendOutputFromAlgorithm (const StaticPortName< T, N > &port, const Core::Algorithms::AlgorithmOutput &output)

Public Member Functions inherited from ModuleInterface
virtual	~ModuleInterface ()

virtual void	setExecutionState (ExecutionState state)=0

virtual void	preDestruction ()

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

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

Public Member Functions inherited from ModuleInfoProvider
virtual	~ModuleInfoProvider ()

Public Member Functions inherited from ModuleDisplayInterface
virtual	~ModuleDisplayInterface ()

Public Member Functions inherited from ExecutableObject
	~ExecutableObject ()

Public Member Functions inherited from AlgorithmCollaborator
virtual	~AlgorithmCollaborator ()

Public Member Functions inherited from LegacyLoggerInterface
virtual	~LegacyLoggerInterface ()

Public Member Functions inherited from StateChangeObserver
	StateChangeObserver ()

void	initStateObserver (ModuleStateInterface *state)

void	stateChanged ()

void	resetStateChanged ()

bool	newStatePresent () const

Static Public Attributes
static Core::Algorithms::AlgorithmParameterName	XSize

static Core::Algorithms::AlgorithmParameterName	YSize

static Core::Algorithms::AlgorithmParameterName	ZSize

static Core::Algorithms::AlgorithmParameterName	PadPercent

static Core::Algorithms::AlgorithmParameterName	DataAtLocation

static Core::Algorithms::AlgorithmParameterName	ElementSizeNormalized

Static Public Attributes inherited from Module
static ModuleStateFactoryHandle	defaultStateFactory_

static Core::Algorithms::AlgorithmFactoryHandle	defaultAlgoFactory_

Additional Inherited Members
Public Types inherited from ModuleInterface
enum	ExecutionState { Waiting, Executing, Completed }

Public Types inherited from NumInputPorts< 2 >
enum

Public Types inherited from NumOutputPorts< 1 >
enum

Static Public Member Functions inherited from Module
static void	resetInstanceCount ()

Static Public Member Functions inherited from Has2InputPorts< FieldPortTag, MatrixPortTag >
static std::vector < SCIRun::Dataflow::Networks::InputPortDescription >	inputPortDescription (const std::string &port0Name, const std::string &port1Name)

Static Public Member Functions inherited from Has1OutputPort< FieldPortTag >
static std::vector < SCIRun::Dataflow::Networks::OutputPortDescription >	outputPortDescription (const std::string &port0Name)

Protected Types inherited from Module
enum	LegacyState { NeedData, JustStarted, Executing, Completed }

Protected Member Functions inherited from Module
Core::Algorithms::AlgorithmBase &	algo ()

void	update_state (LegacyState)

void	setStateBoolFromAlgo (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setStateIntFromAlgo (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setStateDoubleFromAlgo (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setStateStringFromAlgoOption (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setAlgoBoolFromState (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setAlgoIntFromState (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setAlgoDoubleFromState (SCIRun::Core::Algorithms::AlgorithmParameterName name)

void	setAlgoOptionFromState (SCIRun::Core::Algorithms::AlgorithmParameterName name)

virtual size_t	add_input_port (InputPortHandle)

size_t	add_output_port (OutputPortHandle)

virtual void	removeInputPort (const PortId &id)

Protected Attributes inherited from Module
ModuleLookupInfo	info_

ModuleId	id_

Detailed Description

Make an LatVolField that fits the source field.

Constructor & Destructor Documentation

CreateLatVol ( )

Member Function Documentation

void execute ( )

virtual

Todo:: : extract algorithm class!!!!!!!!!!!!!!!!!!!!

Implements ExecutableObject.

INPUT_PORT	(	0	,
		InputField	,
		LegacyField
	)

INPUT_PORT	(	1	,
		LatVolSize	,
		DenseMatrix
	)

OUTPUT_PORT	(	0	,
		OutputField	,
		LegacyField
	)

void setStateDefaults ( )

virtual

Implements ModuleInterface.

Member Data Documentation

AlgorithmParameterName DataAtLocation

static

AlgorithmParameterName ElementSizeNormalized

static

AlgorithmParameterName PadPercent

static

AlgorithmParameterName XSize

static

AlgorithmParameterName YSize

static

AlgorithmParameterName ZSize

static

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

Modules/Legacy/Fields/CreateLatVol.h
Modules/Legacy/Fields/CreateLatVol.cc

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation