stromx::runtime::Queue Class Reference

A data queue of configurable length. More...

#include <Queue.h>

Inheritance diagram for stromx::runtime::Queue:

Public Types
enum	InputId { INPUT }
enum	OutputId { OUTPUT }
enum	ParameterId { SIZE }

Public Member Functions
virtual OperatorKernel *	clone () const
virtual void	setParameter (const unsigned int id, const runtime::Data &value)
virtual const DataRef	getParameter (const unsigned int id) const
virtual void	deactivate ()
virtual void	execute (runtime::DataProvider &provider)
Public Member Functions inherited from stromx::runtime::OperatorKernel
const std::string &	type () const
const std::string &	package () const
const Version &	version () const
const std::vector< const Description * > &	inputs () const
const std::vector< const Description * > &	outputs () const
const std::vector< const Parameter * > &	parameters () const
const Parameter &	parameter (const unsigned int id) const
virtual const Description &	input (const unsigned int id) const
virtual const Description &	output (const unsigned int id) const
const OperatorProperties &	properties () const
virtual void	initialize ()
virtual void	deinitialize ()
virtual void	activate ()
virtual void	interrupt ()

Additional Inherited Members
Protected Member Functions inherited from stromx::runtime::OperatorKernel
	OperatorKernel (const std::string &type, const std::string &package, const Version &version, const std::vector< const Parameter * > &parameters, const OperatorProperties &properties=OperatorProperties())
	OperatorKernel (const std::string &type, const std::string &package, const Version &version, const std::vector< const Description * > &inputs, const std::vector< const Description * > &outputs, const std::vector< const Parameter * > &parameters, const OperatorProperties &properties=OperatorProperties())
	OperatorKernel (const std::string &type, const std::string &package, const runtime::Version &version, const std::vector< const Description * > &inputs, const std::vector< const Description * > &outputs, const OperatorProperties &properties=OperatorProperties())
	OperatorKernel (const std::string &type, const std::string &package, const Version &version, const OperatorProperties &properties=OperatorProperties())
virtual void	initialize (const std::vector< const Description * > &inputs, const std::vector< const Description * > &outputs, const std::vector< const Parameter * > &parameters)
Parameter &	parameter (const unsigned int id)

Detailed Description

A data queue of configurable length.

Member Function Documentation

virtual OperatorKernel* stromx::runtime::Queue::clone ( ) const

inlinevirtual

Returns a copy of the operator, i.e. a object of the same type is allocated and returned. The current status of the operator is not reproduced.

Implements stromx::runtime::OperatorKernel.

void stromx::runtime::Queue::deactivate ( )

virtual

Deactivates the operator, i.e. returns its state to the same as before activation.

Reimplemented from stromx::runtime::OperatorKernel.

void stromx::runtime::Queue::execute ( runtime::DataProvider &  provider )

virtual

Executes the operator.

Parameters

provider

Provides the input data for the execution and accepts its results.

Implements stromx::runtime::OperatorKernel.

const DataRef stromx::runtime::Queue::getParameter ( const unsigned int  ) const

virtual

Gets the current value of the parameter id.

Reimplemented from stromx::runtime::OperatorKernel.

void stromx::runtime::Queue::setParameter ( const unsigned int  , const runtime::Data &    )

virtual

Sets a parameter id to value.

Reimplemented from stromx::runtime::OperatorKernel.

---

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

• stromx/runtime/Queue.h
• stromx/runtime/Queue.cpp