stromx::runtime::DataContainer Class Reference

Container which manages the life-cycle of data objects. More...

#include <DataContainer.h>

Public Member Functions
	DataContainer ()
	DataContainer (runtime::Data *data)
	DataContainer (runtime::Data *data, const bool isReadOnly)
bool	empty () const
void	release ()
bool	isReadOnly () const

Friends
STROMX_RUNTIME_API bool	operator== (const DataContainer &lhs, const DataContainer &rhs)
STROMX_RUNTIME_API bool	operator!= (const DataContainer &lhs, const DataContainer &rhs)
STROMX_RUNTIME_API std::ostream &	operator<< (std::ostream &out, const DataContainer &container)

Detailed Description

Container which manages the life-cycle of data objects.

Constructor & Destructor Documentation

DataContainer() [1/3]

stromx::runtime::DataContainer::DataContainer ( )

inline

Constructs an empty data container.

DataContainer() [2/3]

stromx::runtime::DataContainer::DataContainer ( runtime::Data *  data )

explicit

Constructs a data container holding data.

Parameters

data	A non-zero pointer to a Data object

Exceptions

WrongArgument

DataContainer() [3/3]

stromx::runtime::DataContainer::DataContainer ( runtime::Data *  data, const bool  isReadOnly  )

explicit

Constructs a data container holding data.

Parameters

data	A non-zero pointer to a Data object
isReadOnly	If true the container contains read-only data, i.e. a WriteAccess can not be obtained for this container.

Exceptions

WrongArgument

Member Function Documentation

empty()

bool stromx::runtime::DataContainer::empty ( ) const

inline

Returns whether to DataContainer holds any data.

isReadOnly()

bool stromx::runtime::DataContainer::isReadOnly

(

)

const

Return true if the container is read-only. Also true for empty containers.

release()

void stromx::runtime::DataContainer::release ( )

inline

Releases the data from the container. The container is empty after calling this function.

Friends And Related Function Documentation

operator!=

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

friend

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

operator<<

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

friend

Returns the address of the data held by container.

operator==

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

friend

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

---

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

• stromx/runtime/DataContainer.h
• stromx/runtime/DataContainer.cpp