stromx::runtime::Receive Class Reference

Distributes input data to TCP clients. More...

#include <Receive.h>

Inheritance diagram for stromx::runtime::Receive:

Public Types
enum	DataId { OUTPUT, URL, PORT }

Public Member Functions
virtual OperatorKernel *	clone () const
virtual void	setParameter (const unsigned int id, const Data &value)
const DataRef	getParameter (const unsigned int id) const
virtual void	initialize ()
virtual void	activate ()
virtual void	deactivate ()
virtual void	interrupt ()
virtual void	execute (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 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	deinitialize ()

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

Distributes input data to TCP clients.

Member Function Documentation

activate()

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

deactivate()

void stromx::runtime::Receive::deactivate ( )

virtual

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

Reimplemented from stromx::runtime::OperatorKernel.

execute()

void stromx::runtime::Receive::execute ( 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::Receive::getParameter ( const unsigned int  ) const

virtual

Gets the current value of the parameter id.

Reimplemented from stromx::runtime::OperatorKernel.

initialize()

void stromx::runtime::Receive::initialize ( )

virtual

Initializes the operator. After initialization the operator kernel must be prepared to accept calls to activate().

Reimplemented from stromx::runtime::OperatorKernel.

interrupt()

void stromx::runtime::Receive::interrupt ( )

virtual

Interrupts an executing operator, i.e. the operator stops its execution as soon as possible. The function has no effect if the operator is not currently executing. Note that this function can be called from a thread different than the executing thread at any time.

Reimplemented from stromx::runtime::OperatorKernel.

setParameter()

void stromx::runtime::Receive::setParameter ( const unsigned int  , const 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/Receive.h
• stromx/runtime/Receive.cpp