class Event

Public Methods

virtual int getEvtLength()

getEvtLength() returns the length of the event raw data in longwords (32bit).

virtual int getEvtType()

getEvtType() returns the type of the event.

virtual int getEvtSequence()

getEvtSequence() returns the number of the event in a particular run.

virtual int getRunNumber()

getRunNumber() returns the number of the run to which this event belongs

virtual PHTimeStamp* getTimeStamp() const

getTimeStamp returns the date and time when the event was taken.

virtual void identify(std::ostream& os = std::cout) const

identify will write a short identification message to standard output or to the ostream provided.

virtual void listFrame( const int id=0, std::ostream& os=std::cout) const

listFrame will write a short descriptor of the frame header to the output stream provided.

virtual Packet* getPacket(const int)

getPacket creates and returns a pointer to the packet object with the specified packet id (think of it as a house number).

virtual Packet* getPacket(const int, const int hitFormat)

This interface allows to override the hitformat of the packet.

virtual int getPacketList(Packet*[], const int length)

getPacketList returns a simple-minded array of pointers to the packets in the given event.

virtual int existPacket(const int packetid)

existPacket returns 1 if such a packet exists in the event.

virtual int Copy( int *destination, const int length, int *nw, const char * what ="" )

the event's raw data are copied to destination.

virtual int is_pointer_type() const

converting the Event object means that the actual data it manages are copied to an internal location and are thus safe from being overwritten.

virtual int getEvtLength()

getEvtLength() returns the length of the event raw data in longwords (32bit). If you want to copy the event somewhere, you can find out whether or not you have enough space left.

virtual int getEvtType()

getEvtType() returns the type of the event. Most of the events have the type DATAEVENT, but there are also BEGRUNEVENT, SPILLONEVENT, SPILLOFFEVENT, ENDRUNEVENT, and so on.

virtual int getEvtSequence()

getEvtSequence() returns the number of the event in a particular run. This number is a property of the event. Its run number and the sequence number uniquely indentify an event. It has nothing to do with the position of the event in any given data file.

virtual int getRunNumber()

getRunNumber() returns the number of the run to which this event belongs

virtual PHTimeStamp* getTimeStamp() const

getTimeStamp returns the date and time when the event was taken.

virtual void identify(std::ostream& os = std::cout) const

identify will write a short identification message to standard output or to the ostream provided.

virtual void listFrame( const int id=0, std::ostream& os=std::cout) const

listFrame will write a short descriptor of the frame header to the output stream provided. If id == 0, it will list all frame headers. Otherwise it will list the header of the frame in which the packet with id resides.

virtual Packet* getPacket(const int)

getPacket creates and returns a pointer to the packet object with the specified packet id (think of it as a house number).

virtual Packet* getPacket(const int, const int hitFormat)

This interface allows to override the hitformat of the packet. For debugging purposes mostly.

virtual int getPacketList(Packet*[], const int length)

getPacketList returns a simple-minded array of pointers to the packets in the given event. It returns the number of packets returned in the array. The second parameter tells the packet how long the array is.

virtual int existPacket(const int packetid)

existPacket returns 1 if such a packet exists in the event. 0 else.

virtual int Copy( int *destination, const int length, int *nw, const char * what ="" )

the event's raw data are copied to destination. length is the size of destination, and nw is the number of words actually copied.

if what = "RAW" then we just copy the payload data without the event header.

virtual int is_pointer_type() const

converting the Event object means that the actual data it manages are copied to an internal location and are thus safe from being overwritten. For efficiency, most Event objects initially maintain a pointer to the external raw data only. They are referred to as being pointer-based. If an Event object has already been converted, a second convert operation has no effect.

Alphabetic index HTML hierarchy of classes or Java