#include <RealTimeEffectModelTransformer.h>

Inheritance diagram for RealTimeEffectModelTransformer:

[legend]

Collaboration diagram for RealTimeEffectModelTransformer:

[legend]

Public Types
typedef std::vector< Model * >	Models

enum	Type { RTThread, NonRTThread }

Public Slots
void	start ()

Public Member Functions
	RealTimeEffectModelTransformer (Input input, const Transform &transform)

virtual	~RealTimeEffectModelTransformer ()

void	abandon ()
	Hint to the processing thread that it should give up, for example because the process is going to exit or we want to get rid of the input model. More...

Model *	getInputModel ()
	Return the input model for the transform. More...

int	getInputChannel ()
	Return the input channel spec for the transform. More...

Models	getOutputModels ()
	Return the set of output models created by the transform or transforms. More...

Models	detachOutputModels ()
	Return the set of output models, also detaching them from the transformer so that they will not be deleted when the transformer is. More...

virtual Models	getAdditionalOutputModels ()
	Return any additional models that were created during processing. More...

virtual bool	willHaveAdditionalOutputModels ()
	Return true if the current transform is one that may produce additional models (to be retrieved through getAdditionalOutputModels above). More...

virtual Models	detachAdditionalOutputModels ()
	Return the set of additional models, also detaching them from the transformer. More...

QString	getMessage () const
	Return a warning or error message. More...

Protected Member Functions
virtual void	run ()

DenseTimeValueModel *	getConformingInput ()

Protected Attributes
QString	m_units

RealTimePluginInstance *	m_plugin

int	m_outputNo

Transforms	m_transforms

Input	m_input

Models	m_outputs

bool	m_detached

bool	m_detachedAdd

bool	m_abandoned

QString	m_message

Detailed Description

Definition at line 24 of file RealTimeEffectModelTransformer.h.

Member Typedef Documentation

◆ Models

typedef std::vector<Model *> ModelTransformer::Models

inherited

Definition at line 43 of file ModelTransformer.h.

Member Enumeration Documentation

◆ Type

enum Thread::Type

inherited

Enumerator
RTThread
NonRTThread

Definition at line 29 of file Thread.h.

Constructor & Destructor Documentation

◆ RealTimeEffectModelTransformer()

RealTimeEffectModelTransformer::RealTimeEffectModelTransformer	(	Input	input,
		const Transform &	transform
	)

◆ ~RealTimeEffectModelTransformer()

RealTimeEffectModelTransformer::~RealTimeEffectModelTransformer ( )

virtual

Definition at line 106 of file RealTimeEffectModelTransformer.cpp.

References m_plugin.

Member Function Documentation

◆ run()

void RealTimeEffectModelTransformer::run ( )

protectedvirtual

Implements Thread.

Definition at line 123 of file RealTimeEffectModelTransformer.cpp.

◆ getConformingInput()

DenseTimeValueModel * RealTimeEffectModelTransformer::getConformingInput ( )

protected

Definition at line 112 of file RealTimeEffectModelTransformer.cpp.

References ModelTransformer::getInputModel(), and SVDEBUG.

Referenced by RealTimeEffectModelTransformer(), and run().

◆ abandon()

void ModelTransformer::abandon ( )

inlineinherited

Hint to the processing thread that it should give up, for example because the process is going to exit or we want to get rid of the input model.

Caller should still wait() and/or delete the transform before assuming its input and output models are no longer required.

Definition at line 68 of file ModelTransformer.h.

References ModelTransformer::m_abandoned.

Referenced by ModelTransformerFactory::modelAboutToBeDeleted(), and FeatureExtractionModelTransformer::setCompletion().

◆ getInputModel()

Model* ModelTransformer::getInputModel ( )

inlineinherited

Return the input model for the transform.

Definition at line 73 of file ModelTransformer.h.

References ModelTransformer::Input::getModel(), and ModelTransformer::m_input.

Referenced by getConformingInput(), FeatureExtractionModelTransformer::getConformingInput(), and ModelTransformerFactory::modelAboutToBeDeleted().

◆ getInputChannel()

int ModelTransformer::getInputChannel ( )

inlineinherited

Return the input channel spec for the transform.

Definition at line 78 of file ModelTransformer.h.

References ModelTransformer::Input::getChannel(), and ModelTransformer::m_input.

◆ getOutputModels()

Models ModelTransformer::getOutputModels ( )

inlineinherited

Return the set of output models created by the transform or transforms.

Returns an empty list if any transform could not be initialised; an error message may be available via getMessage() in this situation.

Definition at line 86 of file ModelTransformer.h.

References ModelTransformer::m_outputs.

Referenced by ModelTransformer::detachOutputModels(), ModelTransformerFactory::modelAboutToBeDeleted(), and ModelTransformer::~ModelTransformer().

◆ detachOutputModels()

Models ModelTransformer::detachOutputModels ( )

inlineinherited

Return the set of output models, also detaching them from the transformer so that they will not be deleted when the transformer is.

The caller takes ownership of the models.

Definition at line 93 of file ModelTransformer.h.

References ModelTransformer::getOutputModels(), and ModelTransformer::m_detached.

Referenced by ModelTransformerFactory::transformMultiple().

◆ getAdditionalOutputModels()

virtual Models ModelTransformer::getAdditionalOutputModels ( )

inlinevirtualinherited

Return any additional models that were created during processing.

This might happen if, for example, a transform was configured to split a multi-bin output into separate single-bin models as it processed. These should not be queried until after the transform has completed.

Reimplemented in FeatureExtractionModelTransformer.

Definition at line 105 of file ModelTransformer.h.

Referenced by ModelTransformer::detachAdditionalOutputModels(), and ModelTransformer::~ModelTransformer().

◆ willHaveAdditionalOutputModels()

virtual bool ModelTransformer::willHaveAdditionalOutputModels ( )

inlinevirtualinherited

Return true if the current transform is one that may produce additional models (to be retrieved through getAdditionalOutputModels above).

Reimplemented in FeatureExtractionModelTransformer.

Definition at line 112 of file ModelTransformer.h.

Referenced by ModelTransformerFactory::transformerFinished().

◆ detachAdditionalOutputModels()

virtual Models ModelTransformer::detachAdditionalOutputModels ( )

inlinevirtualinherited

Return the set of additional models, also detaching them from the transformer.

The caller takes ownership of the models.

Definition at line 118 of file ModelTransformer.h.

References ModelTransformer::getAdditionalOutputModels(), and ModelTransformer::m_detachedAdd.

Referenced by ModelTransformerFactory::transformerFinished().

◆ getMessage()

QString ModelTransformer::getMessage ( ) const

inlineinherited

Return a warning or error message.

If getOutputModel returned a null pointer, this should contain a fatal error message for the transformer; otherwise it may contain a warning to show to the user about e.g. suboptimal block size or whatever.

Definition at line 129 of file ModelTransformer.h.

References ModelTransformer::m_message.

Referenced by ModelTransformerFactory::transformMultiple().