JANA2
JHitMessage Struct Referenceabstract

A JHitMessage is an interface used by JTransport for streaming detector hits. More...

#include <JMessage.h>

Inheritance diagram for JHitMessage:
Collaboration diagram for JHitMessage:

Public Member Functions

virtual DetectorId get_source_id () const =0
 Extract the detector ID from the message payload. This is mandatory.
 
virtual Timestamp get_timestamp () const =0
 Extract the detector ID from the message payload. This is mandatory.
 
- Public Member Functions inherited from JMessage
virtual char * as_buffer ()=0
 Expose the underlying buffer via a raw pointer. More...
 
virtual const char * as_buffer () const =0
 Expose the underlying buffer via a raw pointer. More...
 
virtual size_t get_buffer_capacity () const =0
 Determine the length of the buffer itself, a.k.a. More...
 
virtual size_t get_buffer_size () const
 Determine the length of the buffer's contents, a.k.a. More...
 
virtual bool is_end_of_stream () const =0
 Determine whether this is the last message. More...
 

Detailed Description

A JHitMessage is an interface used by JTransport for streaming detector hits.

Either we do event building ourselves using JEventBuilder, or we hydrate an existing event using JDiscreteJoin.

These methods extract the information necessary to figure out which JEvent this Hit belongs to, and also whether we've received data from all detectors needed before emitting a new Event. This works for both discrete-in-time data and continuous-in-time data.


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