Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::SimEvent

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;
 

Description:

SimEvent possesses the following attributes:
AttributeDescription
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:
DataDescription
data A container of Vect objects which contain additional trigger results.
tableTable with additional event information

The data is available through the container objects inside SimEvent. These are accessed via the refData and refTable methods.


Function Member Descriptions:


FrameCPP::Version_3_4_5::SimEvent::SimEvent - Default Constructor.


SimEvent();
This creates a SimEvent object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimEvent::SimEvent - Copy Constructor.


SimEvent(const SimEvent& SimEvent);
This performs a deep copy of all owned data.

Parameters:
ParameterDescription
const SimEvent& SimEventthe object to copy from.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimEvent::SimEvent - Constructor 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);

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimEvent::appendComment - Appends a comment.


inline void appendComment(const std::string& comment);
This method adds a comment followed by a newline to the end of the current list of comments.

Parameters:
ParameterDescription
const std::string& commentThe comment to append.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimEvent::getAmplitude - Continuous output amplitude returned by trigger.


inline REAL_4 getAmplitude() const;
Get continuous output amplitude returned by trigger.

Return value:
REAL_4- Continuous output amplitude returned.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimEvent::getComment - Comment.


inline const std::string& getComment() const;
Get the comment.

Return value:
const std::string&- comment.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::getGTime - Trigger maximum time.


inline const Time& getGTime() const;
Get trigger maximum time.

Return value:
const Time&- Trigger max time.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::getInputs - Inputs.


inline const std::string& getInputs() const;
Get inputs.

Return value:
const std::string&- Inputs.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::SimEvent::getSH - Structure Header


static SH getSH();
Constructs the Structure Header for this class.

Return value:
SH- SimEvent class ID.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimEvent::getTimeAfter - Signal duration after GTime.getSec().


inline REAL_4 getTimeAfter() const;
Get signal duration after trigger maximum.

Return value:
REAL_4- Signal duration after maximum.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::getTimeBefore - Signal duration before GTime.getSec().


inline REAL_4 getTimeBefore() const;
Get signal duration before trigger maximum.

Return value:
REAL_4- Signal duration before maximum.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::operator != - Not-equal comparison.


inline bool operator !=(const SimEvent& SimEvent) const;

Parameters:
ParameterDescription
const SimEvent& sedThe object to compare with.

Return value:
bool- True if the objects are not equal.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::operator += - += Operator.


const SimEvent& operator +=(const SimEvent& SimEvent);

Parameters:
ParameterDescription
const SimEvent& SimEventThe object to be added.

Return value:
const SimEvent&- This object.


FrameCPP::Version_3_4_5::SimEvent::operator = - Assignment Operator.


const SimEvent& operator =(const SimEvent& SimEvent);
This performs a deep copy of all owned data.

Parameters:
ParameterDescription
const SimEvent& SimEventThe object to assign from.

Return value:
const SimEvent&- This object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::SimEvent::operator == - Equal comparison.


bool operator ==(const SimEvent& SimEvent) const;

Parameters:
ParameterDescription
const SimEvent& simThe object to compare with.

Return value:
bool- true if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::SimEvent::read - Reads a SimEvent object from an Input object.


static SimEvent* read(FrameReaderBase& in);
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:
ParameterDescription
FrameReaderBase& inInput data stream object.

Return value:
SimEvent*- Newly created.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failure occured.



FrameCPP::Version_3_4_5::SimEvent::refData - Data Container.


inline SimEvent::DataContainer& refData();
Get the container which contains the data.

Return value:
SearchContainer< Vect, &Vect::getName >&- Data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::refData - const Data Container.


inline const SimEvent::DataContainer& refData() const;
Get the container which contains the data.

Return value:
const SearchContainer< Vect, &Vect::getName >&- Data.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::refTable - Table Container.


inline SimEvent::TableContainer& refTable();
Get table container.

Return value:
Container< Table >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::refTable - const Table Container.


inline const SimEvent::TableContainer& refTable() const;
Get table container.

Return value:
const Container< Table >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::SimEvent::write


virtual void write(Output& out) const;
Writes a SimEvent object to an Output object.

Parameters:
ParameterDescription
Output& out outOutput data stream object.

Exceptions:
ExceptionDescription
write_failureWrite failure occured.



Variable Member Descriptions:


FrameCPP::Version_3_4_5::SimEvent::mAmplitude - Continuous output amplitude returned by event.

REAL_4 mAmplitude;

FrameCPP::Version_3_4_5::SimEvent::mComment - Descriptor of event.

std::string mComment;

FrameCPP::Version_3_4_5::SimEvent::mData - Additional event results.

DataContainer mData;

FrameCPP::Version_3_4_5::SimEvent::mGTime - GPS time.

Time mGTime;

FrameCPP::Version_3_4_5::SimEvent::mInputs - Input channels and filter parameters to event process.

std::string mInputs;

FrameCPP::Version_3_4_5::SimEvent::mName - Name of event.

std::string mName;

FrameCPP::Version_3_4_5::SimEvent::mTable - Additional event information.

TableContainer mTable;

FrameCPP::Version_3_4_5::SimEvent::mTimeAfter - Signal duration after mGtime.

REAL_4 mTimeAfter;

FrameCPP::Version_3_4_5::SimEvent::mTimeBefore - Signal duration before mGtime.

REAL_4 mTimeBefore;