stromx::runtime::PeriodicDelay Class Reference

Periodically delays the execution for a defined amount of time. More...

#include <PeriodicDelay.h>

Inheritance diagram for stromx::runtime::PeriodicDelay:

Public Types
enum	DataId { INPUT, OUTPUT, PERIOD }

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	execute (runtime::DataProvider &provider)
virtual void	activate ()
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 Input * > &	inputs () const
const std::vector< const Output * > &	outputs () const
const std::vector< const Parameter * > &	parameters () const
const Parameter &	parameter (const unsigned int id) const
const Input &	input (const unsigned int id) const
const Output &	output (const unsigned int id) const
const Description &	description (const unsigned int id) const
const OperatorProperties &	properties () const
virtual void	initialize ()
virtual void	deinitialize ()
virtual void	deactivate ()
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 Input *> &inputs, const std::vector< const Output *> &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 Input * > &inputs, const std::vector< const Output * > &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 Input *> &inputs, const std::vector< const Output *> &outputs, const std::vector< const Parameter *> &parameters)
Parameter &	parameter (const unsigned int id)

Detailed Description

Periodically delays the execution for a defined amount of time.

Member Function Documentation

activate()

void stromx::runtime::PeriodicDelay::activate ( )

virtual

Activates the operator. After activation the operator kernel must be prepared to accept calls to execute().

Reimplemented from stromx::runtime::OperatorKernel.

clone()

virtual OperatorKernel* stromx::runtime::PeriodicDelay::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.

execute()

void stromx::runtime::PeriodicDelay::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.

getParameter()

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

virtual

Gets the current value of the parameter id.

Reimplemented from stromx::runtime::OperatorKernel.

setParameter()

void stromx::runtime::PeriodicDelay::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/PeriodicDelay.h
• stromx/runtime/PeriodicDelay.cpp