E2SAR 0.2.0
All Data Structures Namespaces Functions Typedefs Enumerations
e2sar::SyncHdr Struct Reference

#include <e2sarHeaders.hpp>

Public Member Functions

void set (u_int32_t esid, EventNum_t event_num, EventRate_t avg_rate, UnixTimeNano_t ut)
 
u_int32_t get_eventSrcId () const
 
EventNum_t get_eventNumber () const
 
u_int32_t get_avgEventRateHz () const
 
UnixTimeNano_t get_unixTimeNano () const
 
const boost::tuple< u_int32_t, EventNum_t, u_int32_t, UnixTimeNano_t > get_Fields () const
 

Data Fields

char preamble [2] {'L', 'C'}
 
u_int8_t version {synchdrVersion}
 
u_int8_t rsvd {0}
 
u_int32_t eventSrcId {0}
 
EventNum_t eventNumber {0LL}
 
EventRate_t avgEventRateHz {0}
 
UnixTimeNano_t unixTimeNano {0LL}
 

Detailed Description

The Syncr Header. You should always use the provided methods to set and interrogate fields as the structure maintains Big-Endian order internally.

Member Function Documentation

◆ get_avgEventRateHz()

u_int32_t e2sar::SyncHdr::get_avgEventRateHz ( ) const
inline

get avg event rate in Hz in host byte order

◆ get_eventNumber()

EventNum_t e2sar::SyncHdr::get_eventNumber ( ) const
inline

get event number in host byte order

◆ get_eventSrcId()

u_int32_t e2sar::SyncHdr::get_eventSrcId ( ) const
inline

get event src id in host byte order

◆ get_Fields()

const boost::tuple< u_int32_t, EventNum_t, u_int32_t, UnixTimeNano_t > e2sar::SyncHdr::get_Fields ( ) const
inline

Convenience method to get all fields (in host byte order where appropriate). Best way to use it is

u_int32_t eventSrcId; EventNum_t eventNumber; u_int32_t avgEventRateHz; UnixTimeNano_t unixTimeNano;

boost::tie(eventSrcId, eventNumber, avgEventRateHz, unixTimeNano) = synchdr.get_Fields();

◆ get_unixTimeNano()

UnixTimeNano_t e2sar::SyncHdr::get_unixTimeNano ( ) const
inline

get unix time nanoseconds in host byte order

◆ set()

void e2sar::SyncHdr::set ( u_int32_t esid,
EventNum_t event_num,
EventRate_t avg_rate,
UnixTimeNano_t ut )
inline

Set all fields to network/big-endian byte order values


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