TSK_DBI_Context.hxx

Go to the documentation of this file.

#ifndef TSK_DBI_Context_hxx_seen
#define TSK_DBI_Context_hxx_seen

#include <TROOT.h>
#include <TObject.h>



/// Define the context of an event.  The event context uniquely identifies an
/// event within SK_DBI.  Due to the way events are formed, not all event
/// (or slow control data) will have all fields of the context information
/// defined.  Fields that do not contain valid data should be marked using the
/// value TSK_DBI_Context::Invalid.
class TSK_DBI_Context {
public:
    typedef unsigned int Time;
    
    /// A special field value that specifies that the field is invalid.
    static const int Invalid;
    
    /// Construct an empty context.
    TSK_DBI_Context();

    /// Construct a context.
    TSK_DBI_Context(int run, int subRun, int event, int timestamp, int spill, int dataMC=1);

    virtual ~TSK_DBI_Context();

    /// Get dataMC variable
    /// data = 1, MC = 4
    int GetDataMC() const { return fDataMC;}

    /// Add a convenient check to see if this is MC data.  
    bool IsMC() const;     

    /// Set dataMC variable
    /// data = 1, MC = 4
    void SetDataMC(int dm);

    /// Return the run number for this context.
    int GetRun() const;

    /// Set the run number for this context.
    void SetRun(int r);

    /// Return the sub-run number for this context.
    int GetSubRun() const;

    /// Set the sub-run number for this context.
    void SetSubRun(int s);

    /// Return the event number for this context.
    int GetEvent() const;

    /// Set the event number for this context.
    void SetEvent(int e);

    /// Return the spill number for this context.
    int GetSpill() const;

    /// Set the spill number for this context
    void SetSpill(int s);
    
    /// Return the time stamp for this event (only valid to 1 sec)
    int GetTimeStamp() const;

    /// Return the time stamp for this event as a MYSQL compatible time string. 
    std::string GetTimeStampString() const;

    /// Set the time stamp for this event.
    void SetTimeStamp(int t);

    /// Return true if the context is valid.  A valid context is defined as a
    /// context where one or more fields is valid.
    bool Valid() const;

private:

    /// The run number associated with this context
    int fRun;

    /// The sub-run number associated with this context
    int fSubRun;

    /// The event number associated with this context.
    int fEvent;

    /// The spill number associated with this context.
    int fSpill;

    /// The unix time stamp associated with this context
    Time fTimeStamp;

    /// data/MC flag.  data = 1, MC = 4
    int fDataMC;
    ClassDef(TSK_DBI_Context,1);
};

std::ostream& operator<<(std::ostream& s, const TSK_DBI_Context& c);
#endif