OSWtimeContribution Class Reference

Class for decoding the time contribution inserted by the Online SoftWare (OSW) to an EBF event. More...

#include <OSWtimeContribution.h>

Collaboration diagram for OSWtimeContribution:

[legend]List of all members.

Public Types
enum	{ ID = LATidentity_(LATprimaryId::Id_Time, LATsecondaryId::Id_Time) }
Public Member Functions
	OSWtimeContribution ()
	Do nothing constructor.
	OSWtimeContribution (const OSWcontribution &contribution)
	"Copy" constructor taking an OSWcontribution
	~OSWtimeContribution ()
	Do nothing destructor.
const struct timespec *	timeStamp () const
	Return the timespec structure found in the data.
const OSWtimeBase *	timebase () const
	Return the 64 bit timebase value found in the data as two unsigneds.
const unsigned	evtSeqMSW () const
	Return the event sequence number most significant word.
const unsigned	evtSequence () const
	Return the event sequence number.

---

Detailed Description

Class for decoding the time contribution inserted by the Online SoftWare (OSW) to an EBF event.

This class exists to support data taken after the GASU came into existance. Data that falls into this catagory is labeled with the EBFevent::ID typeId. Data taken before this point contains this time stamp information as well, but in the form of a GLTcontribution.

This contribution will disappear some time in the future when FSW provides their own implementation of assigning absolute time to events. It is likely to be very different than what is presented here.

Author:

R. Claus -- GLAST LAT I&T/Online - (claus@slac.stanford.edu)

Revision

1.4

Date:

January 26, 2004 -- Created

Id

OSWtimeContribution.h,v 1.4 2005/04/02 00:11:17 claus Exp

Copyright: Copyright 2004 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved.

---

Constructor & Destructor Documentation

OSWtimeContribution::OSWtimeContribution (  const OSWcontribution &  contribution  )  [inline]

"Copy" constructor taking an OSWcontribution This constructor exists for the Python interface to get around the inability to recast an OSWcontribution as an OSWtimeContribution. This constructor creates a new object by making a copy of the parent OSWcontribution.

---

Member Function Documentation

const unsigned OSWtimeContribution::evtSeqMSW (   )  const [inline]

Return the event sequence number most significant word. The event sequence number most significant word is created by counting the number of times the hardware's event number rolls over. Returns: The event sequence number MSW

const unsigned OSWtimeContribution::evtSequence (   )  const [inline]

Return the event sequence number. The event sequence number is created by concatenating the event sequence number most significant word (32 bits), the hardware event number (15 bits) and the hardware tag (2 bits) value. Only the lower 32 bits of the result are returned as this allows for some 4 billion events in a run, way more then we ever expect to encounter. Returns: The event sequence number

const OSWtimeBase * OSWtimeContribution::timebase (   )  const [inline]

Return the 64 bit timebase value found in the data as two unsigneds. The timebase value comes from a PPC register that increments at a rate given by the board's implementation. Ric hasn't been able to find any supporting documentation giving the rate, but one measurement gives 16.6667 MHz. Returns: A pointer to the timebase structure

const struct timespec * OSWtimeContribution::timeStamp (   )  const [inline]

Return the timespec structure found in the data. The timestamp value comes from the VxWorks real-time clock. The clock is periodically updated. The period is settable through software, but defaults to 60 Hz. Returns: A pointer to the timespec structure

---

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

• OSWtimeContribution.h

---