Class Index | Cross Index | Namespace Index |
Event Data
Contained in: FrameCPP::Version_3_4_5
Derived from:
FrameCPP::Version_3_4_5::Base
Derived by:
none
#include "../../../../../lib/framecpp/src/Version3_4_5/event.hh"
public function member index: |
|||
Event | (); | Default Constructor. | |
Event | (const Event& eventData); | Copy Constructor. | |
Event | (const std::string& name, const std::string& comment, const std::string& inputs, const Time& time, REAL_4 timeBefore, REAL_4 timeAfter, INT_4U eventStatus, REAL_4 amplitude, REAL_4 prob, const std::string& statistics, const std::vector<std::pair<std::string, REAL_4> >& parameters); | Constructor. | |
inline REAL_4 | getAmplitude | () const; | Continuous output amplitude returned by event. |
virtual INT_2U | getClassId | () const; | |
inline const std::string& | getComment | () const; | Event description. |
inline INT_4U | getEventStatus | () const; | Event status defined by the event. |
inline const Time& | getGTime | () const; | Event occurrence time. |
inline const std::string& | getInputs | () const; | Input channels. |
const std::string& | getName | () const; | |
inline const std::vector<std::pair<std::string, REAL_4> >& | getParameters | () const; | Additional parameters |
inline REAL_4 | getProbability | () const; | Probability. |
static SH | getSH | (); | Structure Header. |
static SH | getSH3 | (); | Structure Header. |
static SH | getSH4 | (); | Structure Header. |
inline const std::string& | getStatistics | () const; | Statistical description. |
inline REAL_4 | getTimeAfter | () const; | Signal duration after event occurence |
inline REAL_4 | getTimeBefore | () const; | Signal duration before event occurence |
inline bool | operator != | (const Event& eventData) const; | Not-equal Comparison. |
const Event& | operator += | (const Event& event); | += Operator. |
const Event& | operator = | (const Event& eventData); | Assignment Operator. |
bool | operator == | (const Event& eventData) const; | Equal comparison. |
inline Event::DataContainer& | refData | (); | Data Container. |
inline const Event::DataContainer& | refData | () const; | Data Container |
inline Event::TableContainer& | refTable | (); | Table Container. |
inline const Event::TableContainer& | refTable | () const; | Table Container |
private function member index: |
|||
static Event* | read | (FrameReaderBase& in); | Reads a Event object from an Input object. |
static Event* | read3 | (FrameReaderBase& in); | Read FrameCPP version 3 Trigger Data structure. |
static Event* | read4 | (FrameReaderBase& in); | Read FrameCPP version 4 Trigger Data structure. |
virtual void | write | (Output& out) const; | Writes an Event object to an Output object. |
The Event class stores the following attributes:
Attribute | Description |
name | Name of event |
comment | Descriptor of event |
inputs | Input channels and filter parameters to event process |
GTime | Event occurrent time (integer seconds & nanoseconds) |
timeBefore | Signal duration before event occurence time |
timeAfter | Signal duration after event occurence time |
eventStatus | Defined by event |
amplitude | Continuous output amplitude returned by event |
probability | Likelihood estimate of event. |
statistics | Statistical description of event |
parameters | Additional event parameters |
The Event object also contains the following data:
Data | Description |
data | Vect Container for additional event results. |
table | Table Container for additional event data. |
The data is available through the container object inside Event.
This are accessed via the refData
and refTable
method.
This creates a Event object with the following properties:
- name = "none"
- comment = ""
- inputs = ""
- GTime = 0 seconds, 0 nanoseconds
- timeBefore = 0
- timeAfter = 0
- eventStatus = 0
- amplitude = 0
- probability = -1
- statistics = ""
- parameters = empty list
- No other data.
Exceptions:
Exception | Description |
None. |
This performs a deep copy of the object.
Parameters:
Parameter | Description |
const Event& eventData | Event data to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Creates a Event object with the specified attributes but no data.
Parameters:
Parameter | Description |
const std::string& name | Event name. |
const std::string& comment | Event description. |
const std::string& inputs | Input channels and filter parameters to evenet process. |
const Time& time | Event occurrence time. |
REAL_4 timeBefore | Signal duration before event occurrence. |
REAL_4 timeAfter | Signar dutaion after event occurrence. |
INT_4U eventStatus | Defined by event. |
REAL_4 amplitude | Continuous output amplitude returned by event. |
REAL_4 prob | Likelihood estimate of event. |
const std::string& statistics | Statistical description. |
const std::vector | Additional event parameters. |
Exceptions:
Exception | Description |
None. |
Gets continuous output amplitude returned by event.
Return value:
REAL_4- Event amplitude.
Exceptions:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Gets the description of the event.
Return value:
const std::string&- The event description.
Exceptions:
Exception | Description |
None. | |
None. |
Gets event status.
Return value:
INT_4U- Event status.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the event occurrence time. This is the integer seconds and nanoseconds since the beginning of the frame.
Return value:
const Time&- The event occurrence time.
Exceptions:
Exception | Description |
None. | |
None. |
Gets the input channels and filter parameters to the event process.
Return value:
const std::string&- The input channels and filter parameters.
Exceptions:
Exception | Description |
None. | |
None. |
Gets additional parameter vector
Return value:
const std::vector
Exceptions:
Exception | Description |
None. | |
None. |
Returns the likelihood estimate of the event, if available. This will be -1 if it cannot be estimated.
Return value:
REAL_4- Probability.
Exceptions:
Exception | Description |
None. | |
None. |
Constructs the Structure Header for this class.
Return value:
SH- Structure header for Event Data.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Constructs frame data format version 3 Structure Header for this class.
Return value:
SH- Structure header for Event Data.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Constructs frame data format version 4 Structure Header for this class.
Return value:
SH- Structure header for Event Data.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
Gets the statistical description of the event (if relevant or applicable).
Return value:
const std::string&- Statistics.
Exceptions:
Exception | Description |
None. | |
None. |
Gets signal duration after event occurence.
Return value:
REAL_4- signal duration after event occurence.
Exceptions:
Exception | Description |
None. | |
None. |
Gets signal duration before event occurence.
Return value:
REAL_4- Signal duration before event occurence.
Exceptions:
Exception | Description |
None. | |
None. |
Determines whether two objects are not equal. All contained data is compared.
Parameters:
Parameter | Description |
const Event& eventData | The object to compare with. |
Return value:
bool- True if the objects are not equal, false otherwise.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
const Event& event | Data to be added. |
Return value:
const Event&- This object.
A deep copy is performed for owned data.
Parameters:
Parameter | Description |
const Event& eventData | Data to be copied. |
Return value:
const Event&- This event.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two Event objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const Event& eventData | The object to compare with. |
Return value:
bool- True if the objects are equal.
Exceptions:
Exception | Description |
None. |
This method creates a dynamically allocated object.*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.
Parameters:
Parameter | Description |
Input& in | Frame reader. |
Return value:
Event*- Newly allocated and read data.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
read_failure | Read failed |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
read_failure | Read failed |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed |
read_failure | Read failed |
Get the container which contains the data.
Return value:
SearchContainer< Vect, &Vect::getName >&- Data container.
Exceptions:
Exception | Description |
None. | |
None. |
Get the container which contains the data.
Return value:
const SearchContainer< Vect, &Vect::getName >&
Exceptions:
Exception | Description |
None. | |
None. |
Get table container.
Return value:
SearchContainer< Table, &Table::getName >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Get table container.
Return value:
const SearchContainer< Table, &Table::getName >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
Output& out out | Output data object. |
Exceptions:
Exception | Description |
write_failure | Write failed |