Simulacrum::SAlgorithm Class Reference

#include <salgorithm.h>

Inheritance diagram for Simulacrum::SAlgorithm:

Collaboration diagram for Simulacrum::SAlgorithm:

Public Types
enum	driver_t { Input = true , Output = false }
Public Types inherited from Simulacrum::SConnectable
typedef unsigned	ssignal_t
typedef bool	sdepth_t

Public Member Functions
	SAlgorithm ()
virtual	~SAlgorithm ()
virtual SAlgorithm *	New ()=0
int	inputs () const
int	outputs () const
void	setInput (int, SSpace &, bool doconnect=true)
void	setOutput (int, SSpace &, bool doconnect=true)
void	reset ()
virtual bool	isReady () const
virtual SSpace &	execute ()
SSpace &	operator() (std::initializer_list< std::reference_wrapper< SSpace > >, bool doconnect=false)
void	refresh (bool) override
Public Member Functions inherited from Simulacrum::SConnectable
	SConnectable ()
virtual	~SConnectable ()
void	emitRefresh (sdepth_t)
virtual void	signal (ssignal_t, void *=nullptr)
void	emitSignal (ssignal_t, void *=nullptr)
virtual void	progress (int)
virtual bool	sconnect (SConnectable &)
virtual bool	sconnect (SConnectable &, bool delondiscon)
virtual bool	sdisconnect (SConnectable &)
virtual void	disconnectSources ()
virtual void	disconnectListeners ()
virtual void	disconnectListeners_Refresh ()
virtual bool	isConnected (SConnectable &) const
virtual bool	isConnected (SConnectable *) const
virtual void	sconfigure (const std::string &)
virtual SConnectable &	end ()
virtual SConnectable &	penum ()
virtual SConnectable &	pred ()
virtual SConnectable &	succ ()
virtual void	deleteOnDisconnect (bool)
virtual bool	deleteOnDisconnect ()
virtual void	setName (const std::string &)
virtual const std::string &	getName () const
const std::map< std::string, double > &	parameters ()
const std::map< std::string, std::string > &	properties ()
bool	hasProperty (const std::string &) const
bool	hasParameter (const std::string &) const
void	setProperty (const std::string &, const std::string &)
void	setParameter (const std::string &, double)
std::string	getProperty (const std::string &) const
double	getParameter (const std::string &) const
Public Member Functions inherited from Simulacrum::SLockable
virtual void	lock ()
virtual void	unlock ()
virtual bool	try_lock ()
virtual void	wait ()
virtual void	refIncr ()
virtual void	refDecr ()
virtual int	refCount ()
	SLockable ()
	SLockable (const SLockable &)
virtual	~SLockable ()

Static Public Member Functions
static std::string	typeString ()

Protected Member Functions
void	setInputs (int)
void	setOutputs (int)
SSpace &	input (int) const
SSpace &	output (int) const
SSpace &	driver ()
void	setDriver (driver_t, int)
void	setBlockSize (const SCoordinate &)
const SCoordinate &	blocksize () const
virtual void	init ()=0
virtual void	preExecute ()
virtual void	doExecute ()=0
virtual void	postExecute ()
Protected Member Functions inherited from Simulacrum::SConnectable
virtual bool	addListener (SConnectable &)
virtual bool	removeListener (SConnectable &)
virtual bool	addTarget (SConnectable &)
virtual bool	removeTarget (SConnectable &)

Member Enumeration Documentation

driver_t

enum Simulacrum::SAlgorithm::driver_t

Enumerator
Input
Output

Constructor & Destructor Documentation

SAlgorithm()

SAlgorithm::SAlgorithm

(

)

~SAlgorithm()

SAlgorithm::~SAlgorithm ( )

virtual

Member Function Documentation

blocksize()

const SCoordinate & SAlgorithm::blocksize ( ) const

protected

doExecute()

virtual void Simulacrum::SAlgorithm::doExecute ( )

protectedpure virtual

Implemented in Simulacrum::SAlgorithmCPU.

driver()

SSpace & SAlgorithm::driver ( )

protected

execute()

SSpace & SAlgorithm::execute ( )

virtual

init()

virtual void Simulacrum::SAlgorithm::init ( )

protectedpure virtual

Implemented in Simulacrum::SAlgorithmCPU, Simulacrum::SFilter, Simulacrum::SIsoNormZSlices, Simulacrum::SBucketHistogram, Simulacrum::SAlgorithmSLua, and Simulacrum::ATestAlgorithmPlugin.

input()

SSpace & SAlgorithm::input ( int  inputval ) const

protected

inputs()

int SAlgorithm::inputs

(

)

const

isReady()

bool SAlgorithm::isReady ( ) const

virtual

New()

virtual SAlgorithm* Simulacrum::SAlgorithm::New ( )

pure virtual

Implemented in Simulacrum::SAlgorithmCPU, Simulacrum::SFilter, Simulacrum::SIsoNormZSlices, Simulacrum::SBucketHistogram, Simulacrum::SAlgorithmSLua, and Simulacrum::ATestAlgorithmPlugin.

operator()()

SSpace & SAlgorithm::operator()	(	std::initializer_list< std::reference_wrapper< SSpace > >	spaces,
		bool	doconnect = false
	)

output()

SSpace & SAlgorithm::output ( int  outputval ) const

protected

outputs()

int SAlgorithm::outputs

(

)

const

postExecute()

void SAlgorithm::postExecute ( )

protectedvirtual

Reimplemented in Simulacrum::SIsoNormZSlices.

preExecute()

void SAlgorithm::preExecute ( )

protectedvirtual

Reimplemented in Simulacrum::SFilter, Simulacrum::SIsoNormZSlices, and Simulacrum::SBucketHistogram.

refresh()

void SAlgorithm::refresh ( bool  deep )

overridevirtual

Reimplemented from Simulacrum::SConnectable.

reset()

void SAlgorithm::reset

(

)

setBlockSize()

void SAlgorithm::setBlockSize ( const SCoordinate &  newbs )

protected

setDriver()

void SAlgorithm::setDriver ( driver_t  drvin, int  drvnum  )

protected

setInput()

void SAlgorithm::setInput	(	int	pos,
		SSpace &	sref,
		bool	doconnect = true
	)

setInputs()

void SAlgorithm::setInputs ( int  newin )

protected

setOutput()

void SAlgorithm::setOutput	(	int	pos,
		SSpace &	sref,
		bool	doconnect = true
	)

setOutputs()

void SAlgorithm::setOutputs ( int  newout )

protected

typeString()

std::string SAlgorithm::typeString ( )

static

---

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

• Core/salgorithm.h
• Core/salgorithm.cpp