#include <ImFusion/Stream/CreateStreamAlgorithm.h>

Algorithm template to create streams. More...

Inheritance diagram for CreateStreamAlgorithm< T, autoOpenDefaultValue, autoConnectDefaultValue, takesArguments >:

Detailed Description

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

Algorithm template to create streams.

This template can be used to conveniently instantiate and configure a processing / non-IO 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).
takesArguments	If true, the stream constructor takes a DataList as argument. The Stream must then also implement a static method `bool isCompatible(const DataList&)` that checks if the Stream can be created with the given DataList. Default is false.

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

// A custom processing stream that processes images from an input ImageStream
class DemoProcessingStream : public ImFusion::ImageStream, public ImFusion::SignalReceiver
{
public:
    static bool isCompatible(const DataList& inputData)
    {
        // Check if the input data contains an ImageStream
        return inputData.getFirst<ImageStream>() != nullptr;
    }
 
    explicit DemoProcessingStream(const DataList& inputData) : ImageStream("processed images")
    {
        m_inputStream = inputData.getFirst<ImageStream>();
 
        if (!m_inputStream) throw std::runtime_error("DemoProcessingStream requires an ImageStream as input data");
        m_inputStream->signalStreamData.connect(this, &DemoProcessingStream::processImage);
    }
    ~DemoProcessingStream() override
    {
        disconnectAll(); // Ensure our signal connections are cleaned up
    }
 
    void processImage(std::shared_ptr<const StreamData> inputData)
    {
        const auto imageData = std::dynamic_pointer_cast<const ImageStreamData>(inputData);
 
        // Here you would process the input image data and emit the processed image.
        // For demonstration, we just print a message and emit the same images.
        std::cout << "Processing image from input stream: " << m_inputStream->name() << std::endl;
 
        // Emit a new ImageStreamData with processed data
        auto outputData = std::make_shared<ImageStreamData>(this);
        outputData->setImages(imageData->images2()); // Just passing through the input image(s) for now
        signalStreamData.emitSignal(outputData);
    }
 
    std::optional<WorkContinuation> doWork() override { return {}; };
    bool openImpl() override { return true; };
    bool closeImpl() override { return true; };
    bool startImpl() override { return true; };
    bool stopImpl() override { return true; }
    std::string uuid() override { return "DemoProcessingStream"; }
private:
    const ImageStream* m_inputStream;
};
 
// Register the DemoProcessingStream in the AlgorithmFactory and ControllerFactory
 
// Create a type alias, to not have to repeat the template arguments
using DemoProcessingAlgorithm = ImFusion::CreateStreamAlgorithm<DemoProcessingStream, true, true, true>;
 
MyAlgorithmFactory::MyAlgorithmFactory() : AlgorithmFactory("MyPlugin", false)
{
    // register the DemoProcessingAlgorithm, which creates a DemoProcessingStream with the Algorithm inputs
    registerAlgorithm<DemoProcessingAlgorithm>("DemoProcessingAlgorithm", "Demo;Demo Processing Stream");
}
 
MyControllerFactory::MyControllerFactory() : AlgorithmControllerFactory("MyPlugin", false)    { }
 
AlgorithmController* MyControllerFactory::create(Algorithm* a) const
{
    // use the StreamControllerBase for the DemoProcessingAlgorithm
    if (auto alg = dynamic_cast<DemoProcessingAlgorithm*>(a))
        return new StreamControllerBase(alg);
    return nullptr;
}

Examples: StreamAlgorithmFactory.cpp.

Public Member Functions
	CreateStreamAlgorithm (DataList dl)
	Constructor.

void	compute () override
	Instantiates a new stream.

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 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 int	status () const
	Indicates the status of the last call to compute().

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 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 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

DataList	m_dl = {}

std::unique_ptr< Properties >	m_props
	Properties for stream configuration.

bool	m_autoOpen
	Defines whether Stream::open() is called after stream is created.

bool	m_autoStart
	Defines whether Stream::start() is called after stream is created.

Protected Attributes inherited from StreamAlgorithmBase
bool	m_isOutputTaken = false

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 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, bool takesArguments = false>

void compute ( )

inlineoverridevirtual

Instantiates a new stream.

Implements Algorithm.

◆ takeOutput()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false, bool takesArguments = 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, bool takesArguments = false>

Stream * stream ( )

inlineoverridevirtual

Implements StreamAlgorithmBase.

◆ configure()

template<class T, bool autoOpenDefaultValue = true, bool autoConnectDefaultValue = false, bool takesArguments = 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, bool takesArguments = 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, bool takesArguments = 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/CreateStreamAlgorithm.h

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ compute()

◆ takeOutput()

◆ stream()

◆ configure()

◆ configuration()

◆ resetStream()