tcspc::time_reached_event< DataTypes > Struct Template Reference

Description

template<typename DataTypes = default_data_types>
struct tcspc::time_reached_event< DataTypes >

Event indicating latest abstime reached.

This event has two purposes:

1. To convey the passage of abstime even when there are otherwise no events, including the information that a certain time point has been reached (this is sometimes necessary to detect the end of a measurement when there are no detections)
2. To ensure that a (branch of) the processing graph will not be devoid of events for long stretches of abstime (and, in the case of processing live acquired data, wall clock time).

Data sources (typically device event decoders or the data acquisition itself) should emit this event in order to preserve information about the last time reached by the acquisition (especially at the end of the stream), when otherwise there would be no event emitted. The frequency of time-reached events can be adjusted using tcspc::regulate_time_reached().

See also

tcspc::regulate_time_reached()

Template Parameters

DataTypes

data type set specifying abstime_type

Public Attributes
DataTypes::abstime_type	abstime
	The absolute time (a.k.a. macrotime) of this event.

Friends
auto	operator<< (std::ostream &s, time_reached_event const &e) -> std::ostream &
	Stream insertion operator.
auto	operator== (time_reached_event const &lhs, time_reached_event const &rhs) noexcept -> bool=default
	Equality comparison operator.

---

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

• libtcspc/time_tagged_events.hpp