EBF_evt.ih File Reference
Defines the inlines associated with the event header.
More...
#include <EDS/EBF_evt.h>
#include <EDS/EBF_pkt.h>
#include <EDS/EBF_ctb.h>
#include <EDS/EBF_edw.h>
Detailed Description
Defines the inlines associated with the event header.
- Author:
- JJRussell - russell@slac.stanford.edu
CVS $Id: EBF_evt.ih,v 1.3 2011/03/25 22:16:55 russell Exp $
- The inlines defined in this file reference the LCBD private data. They are meant to be used only went writing IO for EBF streams. They must not be used in general purpose code since they depend on knowledge about the driver.
Function Documentation
| static __inline EBF_evt * EBF__evtNext |
( |
const EBF_evt * |
evt |
) |
[static] |
Returns a pointer to the next event.
- Returns:
- Pointer to the next event
- Parameters:
-
| evt | Pointer to the current event |
- Note:
- Note that this routine makes no guarantee that there is a next event. It merely advances the pointer to one past the end of the base event.
- Warning:
- One should use this function with caution. In the case of multi-packet events, no integrity checking is done on the packets. The routine simply keeps adding up the size of each packet while the receive status is PACKET_TRUNCATED. It is really meant to be used with a prepared set of data (e.g. from GLEAM, but not directly from the Event Builder Module via the LCB) were integrity is not an issue
References EBF__evtSize().
| static __inline int EBF__evtSize |
( |
const EBF_evt * |
evt |
) |
[static] |
Returns the size in bytes, of the specified event.
- Returns:
- The size in bytes, of the specified event
- Parameters:
-
- Note:
- This is the size of the data portion of the event. It includes the the fixed header size.
- Warning:
- One should use this function with caution. In the case of multi-packet events, no integrity checking is done on the packets. The routine simply keeps adding up the size of each packet while the receive status is PACKET_TRUNCATED. It is really meant to be used with a prepared set of data (e.g. from GLEAM, but not directly from the Event Builder Module via the LCB) were integrity is not an issue
References _EBF_edw::bf, EBF_EDW_LEN_TO_BYTES, EBF_EDW_RSTATUS_K_PACKET_TRUNCATED, _EBF_evt::hdr, _EBF_edw_bf::len, _EBF_edw_bf::rstatus, _EBF_edw::ui, and _EBF_pktHdr::undef.
Referenced by EBF__evtNext().
