CreateStreamIoAlgorithm< T, autoOpenDefaultValue, autoConnectDefaultValue > Class Template Reference

#include <ImFusion/Stream/CreateStreamIoAlgorithm.h>

IO algorithm template to create streams. More...

Inheritance diagram for CreateStreamIoAlgorithm< T, autoOpenDefaultValue, autoConnectDefaultValue >:

Detailed Description

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>
class ImFusion::CreateStreamIoAlgorithm< T, autoOpenDefaultValue, autoConnectDefaultValue >

IO algorithm template to create streams.

To create an IO stream in the ImFusion Suite, an IO algorithm is necessary. This template can be used to conveniently instantiate and configure a stream, and optionally also open and start it. This is mostly intended for use in plugin factories.

Template Parameters

T	The type of the stream to be created, which must derive from Stream.
autoOpenDefaultValue	The default value for the autoOpen flag, which defines whether open() is called after the stream is created. Default is true. The value of the flag can then be overridden using the configure interface (e.g. if the stream is created as part of a workspace file).
autoConnectDefaultValue	The default value for the autoConnect flag, which defines whether start() is called after the stream is created. Default is false. The value of the flag can then be overridden using the configure interface (e.g. if the stream is created as part of a workspace file).

It is possible to use this as a base class for creating streaming algorithms with an abstract stream type. In this case, the derived class should override compute(), instantiate the stream and assign it to the algorithm with setStream(stream).

Example usage of the CreateStreamIoAlgorithm in the Algorithm and Controller factories of a plugin:

// class DemoInputStream : public ImFusion::Stream...
 
// Create a type alias, to not have to repeat the template arguments
using DemoInputIoAlgorithm = ImFusion::CreateStreamIoAlgorithm<DemoInputStream, true, true>;
 
MyAlgorithmFactory::MyAlgorithmFactory() : AlgorithmFactory("MyPlugin", false)
{
    // register the DemoInputIoAlgorithm, which creates a DemoInputStream
    registerAlgorithm<DemoInputIoAlgorithm>("DemoInputIoAlgorithm", "Demo;Demo Input Stream");
}
 
MyControllerFactory::MyControllerFactory() : AlgorithmControllerFactory("MyPlugin", false)    { }
 
AlgorithmController* MyControllerFactory::create(Algorithm* a) const
{
    // use the StreamControllerBase for the DemoInputIoAlgorithm
    if (auto alg = dynamic_cast<DemoInputIoAlgorithm*>(a))
        return new StreamControllerBase(alg);
    return nullptr;
}

Public Member Functions
	CreateStreamIoAlgorithm ()
	Constructor.
void	compute () override
	Instantiates a new stream.
void	setStream (T *stream)
	Assigns a stream instance to the algorithm.
OwningDataList	takeOutput () override
	Returns an OwningDataList containing the stream and sets m_isOutputTaken to true.
Stream *	stream () override
T *	typedStream ()
void	configure (const Properties *p) override
	Clones the configuration to later apply it to the stream.
void	configuration (Properties *p) const override
	Assigns the configuration of the stream or the cached properties, if either exists.
Public Member Functions inherited from StreamAlgorithmBase
bool	isOutputTaken () const
virtual DataGroup *	dataGroup ()
Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.
	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.
SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.
Public Member Functions inherited from IoAlgorithm
	IoAlgorithm (IoMode ioMode, int locationType)
	Constructor for initializing IO algorithm.
virtual IoMode	ioMode () const
	Return IO mode.
virtual std::vector< std::string >	supportedFileExtensions () const
	Return supported file extensions (for file based IO)
virtual std::string	suggestedSaveFileName () const
	Return a file name suggestion typically used by IoController to prefill the file name in the save file dialog (for file based write)
virtual bool	canLoad (const Filesystem::Path &filepath) const
	Returns whether the algorithm is suitable for loading the indicated file.
virtual bool	fail (int *errorCode=nullptr) const
int	status () const override
	Indicates the status of the last call to compute().
virtual int	supportedLocations () const
	Return combination of supported location types from LocationType enum.
virtual void	setLocation (const std::string &location)
	Set location for subsequent loading/saving.
virtual std::string	location () const
	Get location for loading/saving.
void	configure (const Properties *p) override
	Set one or multiple properties.
void	configuration (Properties *p) const override
	Retrieve the properties of this object.
std::unique_ptr< Properties >	userOptions (bool includeReadOptions, bool includeWriteOptions) const
	Convenience method to retrieve all properties from this IoAlgorithm that are tagged as user options to be configured during load/save.
void	configureFromGlobalSettings ()
	Convenience method to configure the algorithm's user options with the values stored in the global settings.
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Returns true if data is empty. If a is not 0, create algorithm with input data.
Static Public Member Functions inherited from IoAlgorithm
static std::unique_ptr< IoAlgorithm >	createFromLastDataSource (const DataSourceComponent &dsc)
	Virtual constructor that creates the IoAlgorithm recorded last in the DataSourceComponent.
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Protected Member Functions
void	resetStream () override
	Deletes the stream if m_isOutputTaken is false. In any case sets the stream to nullptr.
Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Member Functions inherited from IoAlgorithm
void	recordToDataSourceComponent (Data &data, int indexInFile)
	Append the current configuration of the IoAlgorithm to the DataSourceComponent of a data.
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.

Protected Attributes
T *	m_stream = nullptr
std::unique_ptr< Properties >	m_props
	Properties for stream configuration.
bool	m_autoOpen
	Defines whether open() is called after stream is created.
bool	m_autoStart
	Defines whether start() is called after stream is created.
Protected Attributes inherited from StreamAlgorithmBase
bool	m_isOutputTaken = false
Protected Attributes inherited from IoAlgorithm
std::string	m_location
IoMode	m_ioMode
int	m_locationType
bool	m_fail
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Types inherited from IoAlgorithm
enum	IoMode { Read = 0 , Write = 1 }
enum	LocationType {   File = 1 , Folder = 2 , URI = 4 , OpenIGTLink = 8 ,   Device = 16 }
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Member Function Documentation

compute()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>

void compute ( )

inlineoverridevirtual

Instantiates a new stream.

Implements Algorithm.

takeOutput()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>

OwningDataList takeOutput ( )

inlineoverridevirtual

Returns an OwningDataList containing the stream and sets m_isOutputTaken to true.

If m_isOutputTaken is already true then an empty list is returned.

Reimplemented from StreamAlgorithmBase.

stream()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>

Stream * stream ( )

inlineoverridevirtual

Implements StreamAlgorithmBase.

configure()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>

void configure ( const Properties * p )

inlineoverridevirtual

Clones the configuration to later apply it to the stream.

Reimplemented from Configurable.

configuration()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>

void configuration ( Properties * p ) const

inlineoverridevirtual

Assigns the configuration of the stream or the cached properties, if either exists.

Reimplemented from Configurable.

resetStream()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false>

void resetStream ( )

inlineoverrideprotectedvirtual

Deletes the stream if m_isOutputTaken is false. In any case sets the stream to nullptr.

Implements StreamAlgorithmBase.

---

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

• ImFusion/Stream/CreateStreamIoAlgorithm.h