ReduxLib C++ 2024.3.2
Loading...
Searching...
No Matches
redux::frames::FrameData< T > Class Template Reference

#include <Frame.h>

Public Member Functions

 FrameData (T value, units::second_t timestamp)
 
GetValue ()
 
units::second_t GetTimestamp ()
 

Detailed Description

template<typename T>
class redux::frames::FrameData< T >

Immutable container class for timestamped values.

Constructor & Destructor Documentation

◆ FrameData()

template<typename T >
redux::frames::FrameData< T >::FrameData ( value,
units::second_t  timestamp 
)
inline

Constructs a new FrameData object.

Parameters
valueThe value to hold.
timestampThe timestamp at which the value was received in seconds.

Member Function Documentation

◆ GetTimestamp()

template<typename T >
units::second_t redux::frames::FrameData< T >::GetTimestamp ( )
inline

Gets the timestamp in seconds of when this value was updated. The time base is relative to the FPGA timestamp.

Returns
the timestamp in seconds.

◆ GetValue()

template<typename T >
T redux::frames::FrameData< T >::GetValue ( )
inline

Returns the value of the data frame.

Returns
the value the data frame holds.

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