dueca::MultiStreamReader< T, E > Class Template Reference

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

#include <MultiStreamReader.hxx>

Inheritance diagram for dueca::MultiStreamReader< T, E >:

Collaboration diagram for dueca::MultiStreamReader< T, E >:

Public Member Functions
	MultiStreamReader (MultiStreamReadToken< T > &token, const TimeSpec &ts)
	Constructor.
	~MultiStreamReader ()
	Destructor.
bool	ok ()
	Check that the stream reading is OK.
Public Member Functions inherited from dueca::DataReader< T, S >
	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, template< class > class E = MatchIntervalStartOrEarlier>
class dueca::MultiStreamReader< T, E >

This is a facilitator for reading stream data.

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

Parameters

T	Type of data that is used in the channel.
E	Extrapolator, may perform internal integration to obtain an estimate of the data at a different time. The default performs no extrapolation.

Constructor & Destructor Documentation

MultiStreamReader()

template<class T , template< class > class E = MatchIntervalStartOrEarlier>

dueca::MultiStreamReader< T, E >::MultiStreamReader ( MultiStreamReadToken< T > & token, const TimeSpec & ts )

inline

Constructor.

Gains access to the channel for which the token was made. The data returned is valid at the start of the time specification, or, if no data is available yet, the latest data in the channel.

Parameters

token	Read access token.
ts	Time specification.

~MultiStreamReader()

template<class T , template< class > class E = MatchIntervalStartOrEarlier>

dueca::MultiStreamReader< T, E >::~MultiStreamReader ( )

inline

Destructor.

Releases the access again with a token.

Member Function Documentation

ok()

template<class T , template< class > class E = MatchIntervalStartOrEarlier>

bool dueca::MultiStreamReader< T, E >::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/MultiStreamReader.hxx