dueca::EventReader< T > Class Template Reference

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

#include <EventReader.hxx>

Inheritance diagram for dueca::EventReader< T >:

Collaboration diagram for dueca::EventReader< T >:

Public Member Functions
	EventReader (EventChannelReadToken< T > &token, const TimeSpec &ts=TimeSpec::end_of_time)
	Constructor.
	~EventReader ()
	Destructor.
const SimTime	getTime ()
	Get the actual time of the event.
const TimeTickType	getTick ()
	Get the actual tick of the event.
const GlobalId &	getMaker ()
	Get a reference to the event's creator id.
Public Member Functions inherited from dueca::DataReader< T, VirtualJoin >
	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::EventReader< T >

This is a facilitator for reading event data.

By creating an "EventReader", the access token is used to gain access to the event in the channel. You can read out the data in the event, the time and the creator of the event.

Constructor & Destructor Documentation

EventReader()

template<class T >

dueca::EventReader< T >::EventReader ( EventChannelReadToken< T > & token, const TimeSpec & ts = TimeSpec::end_of_time )

inline

Constructor.

Gains access to the channel for which the token was made, and makes the next event available, given that it already exists at the specified time.

Parameters

token	Read access token.
ts	Time specification. Only events valid at or before the start of the period defined in ts can be read. Default value for ts is the end of time.

~EventReader()

template<class T >

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

inline

Destructor.

Does nothing.

---

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

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