ChannelReadInterval< T > Class Template Reference

An object that allows read access to a whole interval of channel data. More...

#include <fw/ChannelReadInterval.h>

Classes
class	const_iterator
	Const iterator for iterating over the interval. More...

Public Types
typedef std::list< ChannelRead< T > >	IntervalList
typedef const_iterator	iterator

Public Member Functions
const_iterator	begin () const
const_iterator	end () const
std::size_t	size () const
bool	empty () const
	ChannelReadInterval ()
	Constructs an empty interval. More...
	ChannelReadInterval (ChannelTypePtr channel, std::list< ChannelBufferBase::Slot *> &slotList)
	Constructs an interval on channel with given range. More...
void	finish ()
const std::string &	getChannelID ()
std::string	getTypename () const
TypeMetaPtr	getTypeMeta () const
Channel< T >	getChannel ()
	Returns a read-only channel proxy object of the underlying channel. More...

Detailed Description

template<typename T>
class mira::ChannelReadInterval< T >

An object that allows read access to a whole interval of channel data.

Use Channel::readInterval to obtain access to data of a channel.

The ChannelReadInterval contains a list of ChannelRead objects and takes care of unlocking. One can iterate over the interval using the built in iterators. It is also possible to take a single ChannelRead out of the interval and to unlock the whole interval. The single ChannelRead will still be read locked.

Member Typedef Documentation

IntervalList

typedef std::list<ChannelRead<T> > IntervalList

iterator

typedef const_iterator iterator

Constructor & Destructor Documentation

ChannelReadInterval() [1/2]

ChannelReadInterval ( )

inline

Constructs an empty interval.

ChannelReadInterval() [2/2]

ChannelReadInterval ( ChannelTypePtr  channel, std::list< ChannelBufferBase::Slot *> &  slotList  )

inline

Constructs an interval on channel with given range.

Member Function Documentation

begin()

const_iterator begin ( ) const

inline

end()

const_iterator end ( ) const

inline

size()

std::size_t size ( ) const

inline

empty()

bool empty ( ) const

inline

finish()

void finish ( )

inline

getChannelID()

const std::string& getChannelID ( )

inline

getTypename()

std::string getTypename ( ) const

inline

getTypeMeta()

TypeMetaPtr getTypeMeta ( ) const

inline

getChannel()

Channel<T> getChannel

(

)

Returns a read-only channel proxy object of the underlying channel.

---

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

• framework/include/fw/ChannelReadInterval.h