stromx::runtime Namespace Reference

Runtime library. More...

Classes
class	AbstractFactory
	Factory of operator and data objects. More...
class	AccessEmpty
	Tried to get the data of an empty read or write access. More...
class	AssignThreadsAlgorithm
	Algorithm which assigns threads to the stream. More...
class	BadCast
	An impossible cast was attempted. More...
class	Block
	Blocks the execution until a trigger signal is received. More...
class	Color
	RGB color. More...
class	Compare
	Compare operation of floating point values. More...
class	Connector
	Identifier of a connector of an operator. More...
class	ConnectorDescription
	Description of a connector. More...
class	ConnectorObserver
	Abstract base class of observers of operator connectors. More...
class	ConstData
	Outputs a constant value. More...
class	ConstDataRef
	Reference to a constant data object. More...
class	Counter
	Outputs an increasing integer value. More...
class	Data
	Abstract data object. More...
class	DataAllocationFailed
	Data could not be allocated. More...
class	DataContainer
	Container which manages the life-cycle of data objects. More...
class	DataException
	Error related to a Data object. More...
class	DataInterface
	Common interface of data objects or references to data objects. More...
class	DataOperatorBase
class	DataProvider
	Provider of functions to receive and send data. More...
class	DataRef
	Reference to a data object. More...
class	Description
	Abstract description of an ID to variant map. More...
class	DeserializationError
	Data could not be deserialized. More...
class	DirectoryFileInput
	File input which reads the input files from a common directory. More...
class	DirectoryFileOutput
	File output which stores the output data in single files in a common directory. More...
class	Dump
	Accepts and releases any input data. More...
class	Enum
	Value of an enumeration. More...
class	EnumDescription
	Description of an enumeration value. More...
class	EnumParameter
	Description of an enumeration parameter More...
class	Exception
	Abstract stromx exception. More...
class	ExceptionObserver
	Abstract base observer of operator exceptions. More...
class	Factory
	Factory of operator and data objects. More...
class	FactoryException
	Error related to a data and operator factory. More...
class	File
	Data object which represents a path to a file. More...
class	FileAccessFailed
	An error occurred during file access. More...
class	FileException
	A file related exception. More...
class	FileInput
	Provides functions to initialize an input provider. More...
class	FileOutput
	Provides functions to initialize an output provider. More...
class	Filter
	Filters input data depending on the filter flag. More...
class	Fork
	Distributes input data to several outputs. More...
class	Id2DataComposite
	A composite expression of two ID-to-data mappers. More...
class	Id2DataMapper
	Abstract base class of ID-to-data mappers. More...
class	Id2DataPair
	A direct map of one ID to one data object. More...
class	Image
	Abstract image. More...
class	ImageWrapper
	Concrete image without memory management. More...
class	InconsistentFileContent
	The file content is not consistent. More...
class	Input
	Description of an input. More...
class	InputConnector
	Identifier of an input connector of an operator. More...
class	InputError
	General error in connection with an operator input. More...
class	InputProvider
	Provides functions to deserialize data from strings and files. More...
class	InternalError
	An internal, unexpected error occurred. More...
class	Interrupt
	The current thread was stopped. More...
class	InvalidFileFormat
	The file format is invalid. More...
class	IsEmpty
class	IsNotEmpty
class	Join
	Distributes input data to several outputs. More...
class	List
	List of data values. More...
class	Locale
class	Matrix
	Abstract image. More...
class	MatrixParameter
	Description of a matrix parameter More...
class	MatrixPropertyBase
class	MatrixWrapper
	Concrete matrix without memory management. More...
class	Merge
	Merges over the entries of an input list. More...
class	NoInputFile
	The input provider has no input file. More...
class	None
	Undefined and empty data object. More...
class	NotImplemented
	A function which is not implemented was called. More...
class	NumericParameter
	Description of a numeric parameter More...
class	Operator
	Abstract operator. More...
class	OperatorAllocationFailed
	Operator could not be allocated. More...
class	OperatorError
	Error in connection with a specified operator. More...
class	OperatorInfo
	Meta-information about an operator. More...
class	OperatorKernel
	Abstract operator kernel. More...
struct	OperatorProperties
class	OperatorTester
	Operator with utility functions for unit testing. More...
class	OutOfMemory
	Not enought memory. More...
class	Output
	Description of an input. More...
class	OutputConnector
	Identifier of an output of an operator. More...
class	OutputError
	General error in connection with an operator output. More...
class	OutputProvider
	Provides functions to serialize data to strings and files. More...
class	Parameter
	Description of a parameter. More...
class	ParameterAccessViolation
	Tried to violate the parameter access mode. More...
class	ParameterError
	General error in connection with a specified parameter. More...
class	ParameterGroup
	A group of parameters. More...
class	PeriodicDelay
	Periodically delays the execution for a defined amount of time. More...
class	Position
	2D position. More...
class	Primitive
	Primitive data value. More...
class	Push
	Blocks the execution until the value parameter is set. More...
class	Queue
	A data queue of configurable length. More...
class	ReadAccess
	Read access to a data container. More...
class	Receive
	Distributes input data to TCP clients. More...
class	RecycleAccess
	Recycle access to a data container. More...
class	Recycler
	Abstract receiver of recycled objects. More...
class	Registry
	Abstract registry of operator and data objects. More...
class	Repeat
	Repeats outputting the input data. More...
class	Send
	Distributes input data to TCP clients. More...
class	SerializationError
	Data could not be serialized. More...
class	SortInputsAlgorithm
	Algorithm which sorts the input sequence of stream threads. More...
class	Split
	Splits over the entries of an input list. More...
class	Stream
	The core data processing pipeline of stromx. More...
class	String
	String data value. More...
class	Thread
	A thread which visits input nodes. More...
class	Timeout
	An operation timed out. More...
class	Tribool
	String data value. More...
class	TriggerData
	Special data value for trigger signals. More...
class	Try
	Operator which renders ID-to-data maps optional. More...
class	TypedList
class	Variant
	VariantInterface implementation of the runtime package. More...
class	VariantComposite
	A composite expression of two variants. More...
class	VariantHandle
class	VariantInterface
	Abstract description of a data variant. More...
class	Version
	A version of an operator or data type. More...
class	Visualization
	Visualization variants. More...
class	WriteAccess
	Write access to a data container. More...
class	WrongArgument
	A wrong argument was passed to a function. More...
class	WrongId
	An object was identified by a wrong ID. More...
class	WrongInputType
	Tried to set an input to data of the wrong type. More...
class	WrongOperatorState
	The current state of the operator does not allow a specific operation. More...
class	WrongOutputType
	Tried to set an output to data of the wrong type. More...
class	WrongParameterId
	A parameter with this ID does not exist. More...
class	WrongParameterType
	Tried to set a parameter to data of the wrong type. More...
class	WrongParameterValue
	Tried to set a parameter to a wrong value. More...
class	WrongState
	The current state does not allow a specific operation. More...
class	XmlReader
	Reader for stromx files. More...
class	XmlWriter
	Writer for stromx files. More...
class	ZipFileInput
	File input which reads the input files from a zip file. More...
class	ZipFileOutput
	File output which stores the output data in a zip file. More...

Typedefs
typedef boost::lock_guard< boost::mutex >	lock_t
typedef boost::unique_lock< boost::mutex >	unique_lock_t
typedef Primitive< bool, bool >	Bool
	Boolean value.
typedef Primitive< int, int8_t >	Int8
	Signed 8-bit integer.
typedef Primitive< unsigned int, uint8_t >	UInt8
	Unsigned 8-bit integer.
typedef Primitive< int, int16_t >	Int16
	Signed 16-bit integer.
typedef Primitive< unsigned int, uint16_t >	UInt16
	Unsigned 16-bit integer.
typedef Primitive< int, int32_t >	Int32
	Signed 32-bit integer.
typedef Primitive< unsigned int, uint32_t >	UInt32
	Unsigned 32-bit integer.
typedef Primitive< int64_t, int64_t >	Int64
	Signed 64-bit integer.
typedef Primitive< uint64_t, uint64_t >	UInt64
	Unsigned 64-bit integer.
typedef Primitive< double, float >	Float32
	Single precision floating point number.
typedef Primitive< double, double >	Float64
	Float64 precision floating point number.

Functions
std::ostream &	operator<< (std::ostream &out, const Color &color)
std::istream &	operator>> (std::istream &in, Color &color)
bool	operator== (const Color &lhs, const Color &rhs)
bool	operator== (const Connector &lhs, const Connector &rhs)
template<typename data_t >
const data_t &	data_cast (ConstDataRef &data)
template<typename data_t >
data_t &	data_cast (Data &data)
template<typename data_t >
const data_t &	data_cast (const Data &data)
template<typename data_t >
data_t *	data_cast (Data *data)
template<typename data_t >
const data_t *	data_cast (const Data *data)
bool	operator== (const runtime::DataContainer &lhs, const runtime::DataContainer &rhs)
bool	operator!= (const runtime::DataContainer &lhs, const runtime::DataContainer &rhs)
std::ostream &	operator<< (std::ostream &out, const runtime::DataContainer &container)
template<typename data_t >
data_t &	data_cast (DataRef &data)
const Id2DataComposite	operator && (const Id2DataMapper &lhs, const Id2DataMapper &rhs)
const Id2DataComposite	operator|| (const Id2DataMapper &lhs, const Id2DataMapper &rhs)
STROMX_RUNTIME_API const Id2DataComposite	operator && (const Id2DataMapper &lhs, const Id2DataMapper &rhs)
bool	operator== (const Matrix &rhs, const Matrix &lhs)
bool	operator!= (const Matrix &rhs, const Matrix &lhs)
template<class T >
T	toNativeType (const Data &data)
int64_t	toInt (const Data &data)
double	toDouble (const Data &data)
Version	version ()
	Returns the version of the stromx runtime library. More...
bool	operator== (const stromx::runtime::String &lhs, const stromx::runtime::String &rhs)
bool	operator!= (const stromx::runtime::String &lhs, const stromx::runtime::String &rhs)
std::ostream &	operator<< (std::ostream &out, const String &string)
STROMX_RUNTIME_API boost::thread_specific_ptr< Thread >	gThread (do_release)
bool	operator== (const stromx::runtime::Tribool &lhs, const stromx::runtime::Tribool &rhs)
bool	operator!= (const stromx::runtime::Tribool &lhs, const stromx::runtime::Tribool &rhs)
std::ostream &	operator<< (std::ostream &out, const Tribool &value)
const VariantHandle	operator && (const VariantHandle &lhs, const VariantHandle &rhs)
const VariantHandle	operator|| (const VariantHandle &lhs, const VariantHandle &rhs)
STROMX_RUNTIME_API const VariantHandle	operator && (const VariantHandle &lhs, const VariantHandle &rhs)
bool	operator== (const VariantInterface &lhs, const VariantInterface &rhs)
std::ostream &	operator<< (std::ostream &out, const VariantInterface &variant)
std::ostream &	operator<< (std::ostream &out, const Version &version)
std::istream &	operator>> (std::istream &in, Version &version)
bool	operator== (const Version &lhs, const Version &rhs)
bool	operator!= (const Version &lhs, const Version &rhs)
bool	operator< (const Version &lhs, const Version &rhs)
bool	operator<= (const Version &lhs, const Version &rhs)
bool	operator>= (const Version &lhs, const Version &rhs)
bool	operator> (const Version &lhs, const Version &rhs)

Variables
std::locale	locale

Detailed Description

Runtime library.

Function Documentation

data_cast() [1/6]

template<typename data_t >

data_t& stromx::runtime::data_cast

(

Data &

data

)

Casts a reference to a data object to data_t &. Throws BadCast if the cast failed.

Exceptions

BadCast

data_cast() [2/6]

template<typename data_t >

const data_t& stromx::runtime::data_cast

(

const Data &

data

)

Casts a constant reference to a data object to const data_t &. Throws BadCast if the cast failed

Exceptions

BadCast

data_cast() [3/6]

template<typename data_t >

data_t* stromx::runtime::data_cast

(

Data *

data

)

Casts a pointer to a data object to data_t*. Returns 0 if the cast failed

data_cast() [4/6]

template<typename data_t >

const data_t& stromx::runtime::data_cast

(

ConstDataRef &

data

)

Casts a constant data reference to const data_t &. Throws BadCast if the cast failed.

Exceptions

BadCast

data_cast() [5/6]

template<typename data_t >

data_t& stromx::runtime::data_cast

(

DataRef &

data

)

Casts a data reference to data_t &. Throws BadCast if the cast failed.

Exceptions

BadCast

data_cast() [6/6]

template<typename data_t >

const data_t* stromx::runtime::data_cast

(

const Data *

data

)

Casts a pointer to a constant data object to const data_t*. Returns 0 if the cast failed

operator &&() [1/4]

STROMX_RUNTIME_API const Id2DataComposite stromx::runtime::operator&&	(	const Id2DataMapper &	lhs,
		const Id2DataMapper &	rhs
	)

Constructs an ID-to-data mapper which requires both lhs and rhs to succeed.

operator &&() [2/4]

STROMX_RUNTIME_API const VariantHandle stromx::runtime::operator&&	(	const VariantHandle &	lhs,
		const VariantHandle &	rhs
	)

Constructs a variant which is a valid super-type of both subtypes lhs and rhs.

Exceptions

WrongArgument

If lhs and rhs is not valid.

operator &&() [3/4]

const VariantHandle stromx::runtime::operator&&	(	const VariantHandle &	lhs,
		const VariantHandle &	rhs
	)

Constructs a variant which is a valid super-type of both subtypes lhs and rhs.

Exceptions

WrongArgument

If lhs and rhs is not valid.

operator &&() [4/4]

const Id2DataComposite stromx::runtime::operator&&	(	const Id2DataMapper &	lhs,
		const Id2DataMapper &	rhs
	)

Constructs an ID-to-data mapper which requires both lhs and rhs to succeed.

operator!=() [1/4]

STROMX_RUNTIME_API bool stromx::runtime::operator!=	(	const DataContainer &	lhs,
		const DataContainer &	rhs
	)

Returns true if the addresses in lhs and rhs are not the same.

operator!=() [2/4]

STROMX_RUNTIME_API bool stromx::runtime::operator!=	(	const String &	lhs,
		const String &	rhs
	)

Returns true if the contents of lhs and rhs are different.

operator!=() [3/4]

STROMX_RUNTIME_API bool stromx::runtime::operator!=	(	const Tribool &	lhs,
		const Tribool &	rhs
	)

Returns true if the contents of lhs and rhs are different.

operator!=() [4/4]

STROMX_RUNTIME_API bool stromx::runtime::operator!=	(	const Matrix &	rhs,
		const Matrix &	lhs
	)

Returns true if the matrices are not equal.

operator<<()

STROMX_RUNTIME_API std::ostream & stromx::runtime::operator<<	(	std::ostream &	out,
		const DataContainer &	container
	)

Returns the address of the data held by container.

operator==() [1/4]

STROMX_RUNTIME_API bool stromx::runtime::operator==	(	const DataContainer &	lhs,
		const DataContainer &	rhs
	)

Returns true if the addresses in lhs and rhs are the same.

operator==() [2/4]

STROMX_RUNTIME_API bool stromx::runtime::operator==	(	const String &	lhs,
		const String &	rhs
	)

Returns true if the contents of lhs and rhs are the same.

operator==() [3/4]

STROMX_RUNTIME_API bool stromx::runtime::operator==	(	const Tribool &	lhs,
		const Tribool &	rhs
	)

Returns true if the contents of lhs and rhs are the same.

operator==() [4/4]

STROMX_RUNTIME_API bool stromx::runtime::operator==	(	const Matrix &	rhs,
		const Matrix &	lhs
	)

Returns true if the sizes, value types and entries of both matrices are equal.

operator||() [1/2]

STROMX_RUNTIME_API const VariantHandle stromx::runtime::operator||	(	const VariantHandle &	lhs,
		const VariantHandle &	rhs
	)

Constructs a variant which is a valid super-type of subtypes either lhs or rhs.

Exceptions

WrongArgument

If lhs or rhs is not valid.

operator||() [2/2]

STROMX_RUNTIME_API const Id2DataComposite stromx::runtime::operator||	(	const Id2DataMapper &	lhs,
		const Id2DataMapper &	rhs
	)

Constructs an ID-to-data mapper which requires either lhs or rhs to succeed.

toDouble()

STROMX_RUNTIME_API double stromx::runtime::toDouble

(

const Data &

data

)

Attempts to cast data to a Primitive object and returns its value as a double.

Exceptions

WrongArgument

The input data is not a primitive.

toInt()

STROMX_RUNTIME_API int64_t stromx::runtime::toInt

(

const Data &

data

)

Attempts to cast data to a Primitive object and returns its value as an integer.

Exceptions

WrongArgument

The input data is not a primitive.

version()

STROMX_RUNTIME_API Version stromx::runtime::version

(

)

Returns the version of the stromx runtime library.

Since

0.2