Class Index | Cross Index | Namespace Index |
Simulated 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/simevent.hh"
public function member index: |
|||
SimEvent | (); | Default Constructor. | |
SimEvent | (const SimEvent& SimEvent); | Copy Constructor. | |
SimEvent | (const std::string& name, const std::string& inputs = "", const Time& GTime = Time( 0, 0 ), REAL_4 timeBefore = 0.0, REAL_4 timeAfter = 0.0, REAL_4 amplitude = 0.0); | Constructor Constructor. | |
inline void | appendComment | (const std::string& comment); | Appends a comment. |
inline REAL_4 | getAmplitude | () const; | Continuous output amplitude returned by trigger. |
virtual INT_2U | getClassId | () const; | |
inline const std::string& | getComment | () const; | Comment. |
inline const Time& | getGTime | () const; | Trigger maximum time. |
inline const std::string& | getInputs | () const; | Inputs. |
const std::string& | getName | () const; | |
static SH | getSH | (); | Structure Header |
inline REAL_4 | getTimeAfter | () const; | Signal duration after GTime.getSec(). |
inline REAL_4 | getTimeBefore | () const; | Signal duration before GTime.getSec(). |
inline bool | operator != | (const SimEvent& SimEvent) const; | Not-equal comparison. |
const SimEvent& | operator += | (const SimEvent& SimEvent); | += Operator. |
const SimEvent& | operator = | (const SimEvent& SimEvent); | Assignment Operator. |
bool | operator == | (const SimEvent& SimEvent) const; | Equal comparison. |
inline SimEvent::DataContainer& | refData | (); | Data Container. |
inline const SimEvent::DataContainer& | refData | () const; | const Data Container. |
inline SimEvent::TableContainer& | refTable | (); | Table Container. |
inline const SimEvent::TableContainer& | refTable | () const; | const Table Container. |
private function member index: |
|||
static SimEvent* | read | (FrameReaderBase& in); | Reads a SimEvent object from an Input object. |
virtual void | write | (Output& out) const; | |
SimEvent possesses the following attributes:
Attribute | Description |
name | Name of trigger |
comment | Descriptor of trigger |
inputs | Input channel and filter parameters to trigger process |
GTime | GPS time (sec,nsec residual) corresponding to maximum of trigger |
timeBefore | Signal duration before GTime.getSec() |
timeAfter | Signal duration after GTime.getSec() |
amplitude | Continuous output amplitude returned by trigger |
The SimEvent object is a container for tow types of data:
Data | Description |
data | A container of Vect objects which contain additional trigger results. |
table | Table with additional event information |
The data is available through the container objects inside SimEvent.
These are accessed via the refData
and refTable
methods.
This creates a SimEvent object with the following properties:
- name = "none"
- comment = ""
- inputs = ""
- GTime = (0,0)
- timeBefore = 0.0
- timeAfter = 0.0
- amplitude = 0.0
- No vector or table data.
Exceptions:
Exception | Description |
None. |
This performs a deep copy of all owned data.
Parameters:
Parameter | Description |
const SimEvent& SimEvent | the object to copy from. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
This method adds a comment followed by a newline to the end of the current list of comments.
Parameters:
Parameter | Description |
const std::string& comment | The comment to append. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
Get continuous output amplitude returned by trigger.
Return value:
REAL_4- Continuous output amplitude returned.
Exceptions:
Exception | Description |
None. | |
None. |
Exceptions:
Exception | Description |
None. |
Get the comment.
Return value:
const std::string&- comment.
Exceptions:
Exception | Description |
None. | |
None. |
Get trigger maximum time.
Return value:
const Time&- Trigger max time.
Exceptions:
Exception | Description |
None. | |
None. |
Get inputs.
Return value:
const std::string&- Inputs.
Exceptions:
Exception | Description |
None. | |
None. |
Constructs the Structure Header for this class.
Return value:
SH- SimEvent class ID.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Get signal duration after trigger maximum.
Return value:
REAL_4- Signal duration after maximum.
Exceptions:
Exception | Description |
None. | |
None. |
Get signal duration before trigger maximum.
Return value:
REAL_4- Signal duration before maximum.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const SimEvent& sed | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const SimEvent& SimEvent | The object to be added. |
Return value:
const SimEvent&- This object.
This performs a deep copy of all owned data.
Parameters:
Parameter | Description |
const SimEvent& SimEvent | The object to assign from. |
Return value:
const SimEvent&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Parameter | Description |
const SimEvent& sim | 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 |
FrameReaderBase& in | Input data stream object. |
Return value:
SimEvent*- Newly created.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Read failure occured. |
Get the container which contains the data.
Return value:
SearchContainer< Vect, &Vect::getName >&- Data.
Exceptions:
Exception | Description |
None. | |
None. |
Get the container which contains the data.
Return value:
const SearchContainer< Vect, &Vect::getName >&- Data.
Exceptions:
Exception | Description |
None. | |
None. |
Get table container.
Return value:
Container< Table >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Get table container.
Return value:
const Container< Table >&- Table.
Exceptions:
Exception | Description |
None. | |
None. |
Writes a SimEvent object to an Output object.
Parameters:
Parameter | Description |
Output& out out | Output data stream object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |