dueca::StreamReader< T > Class Template Reference

This is a facilitator for reading stream data. More...

#include <StreamReader.hxx>

Inheritance diagram for dueca::StreamReader< T >:

Collaboration diagram for dueca::StreamReader< T >:

Public Member Functions
	StreamReader (StreamChannelReadToken< T > &token, const TimeSpec &ts)
	Constructor.
	~StreamReader ()
	Destructor.
bool	ok ()
	Check that the stream reading is OK.
Public Member Functions inherited from dueca::DataReader< T, MatchIntervalStart >
	DataReader (ChannelReadToken &token, const DataTimeSpec &ts)
	Constructor.
	DataReader (ChannelReadToken &token, const TimeSpec &ts)
	Constructor with TimeSpec.
	DataReader (ChannelReadToken &token, TimeTickType ts=MAX_TIMETICK)
	Constructor with time tick.
const T &	data ()
	Access to the data.
const DataTimeSpec &	timeSpec ()
	Return the time specification of the data.
const GlobalId &	origin ()
	Return the origin.
	~DataReader ()
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from dueca::DataReaderBase
	DataReaderBase (ChannelReadToken &token, const DataTimeSpec &t_request)
	Constructor.
Protected Attributes inherited from dueca::DataReaderBase
ChannelReadToken &	token
	Reference to the channel access token.
DataTimeSpec	t_request
	Time span or point requested.
DataTimeSpec	ts_data
	Time specification as realised.
GlobalId	data_origin
	Data origin.
bool	firstaccess
	First access flag.

Detailed Description

template<class T>
class dueca::StreamReader< T >

This is a facilitator for reading stream data.

By creating a "StreamReader", the access token is used to gain access to the data in the channel. When at the end of scope the StreamReader is destroyed, the access is released again.

Constructor & Destructor Documentation

StreamReader()

template<class T >

dueca::StreamReader< T >::StreamReader ( StreamChannelReadToken< T > & token, const TimeSpec & ts )

inline

Constructor.

Gains access to the channel for which the token was made.

Parameters

token	Read access token.
ts	Time specification.

~StreamReader()

template<class T >

dueca::StreamReader< T >::~StreamReader ( )

inline

Destructor.

Releases the access again with a token.

Member Function Documentation

ok()

template<class T >

bool dueca::StreamReader< T >::ok ( )

inline

Check that the stream reading is OK.

Only applicable in code without exceptions.

---

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

• /home/abuild/rpmbuild/BUILD/dueca-4.1.3/dueca/StreamReader.hxx