MQwCodaControlEvent Class Reference

Mix-in class for handling CODA control event data and timing. More...

#include <MQwCodaControlEvent.h>

Inheritance diagram for MQwCodaControlEvent:

Collaboration diagram for MQwCodaControlEvent:

Public Member Functions
	MQwCodaControlEvent ()
	~MQwCodaControlEvent ()
void	ResetControlParameters ()
void	ProcessControlEvent (UInt_t evtype, UInt_t *buffer)
void	ReportRunSummary ()
UInt_t	GetStartTime ()
UInt_t	GetPrestartTime ()
UInt_t	GetPrestartRunNumber ()
UInt_t	GetRunType ()
UInt_t	GetGoTime (int index=0)
UInt_t	GetGoEventCount (int index=0)
UInt_t	GetPauseTime (int index=0)
UInt_t	GetPauseEventCount (int index=0)
UInt_t	GetEndTime ()
UInt_t	GetEndEventCount ()
TString	GetStartSQLTime ()
TString	GetEndSQLTime ()
time_t	GetStartUnixTime ()
time_t	GetEndUnixTime ()

Protected Types
enum	EventTypes {   kSYNC_EVENT = 16 , kPRESTART_EVENT = 17 , kGO_EVENT = 18 , kPAUSE_EVENT = 19 ,   kEND_EVENT = 20 }

Protected Member Functions
void	ProcessSync (UInt_t local_time, UInt_t statuscode)
void	ProcessPrestart (UInt_t local_time, UInt_t local_runnumber, UInt_t local_runtype)
void	ProcessGo (UInt_t local_time, UInt_t evt_count)
void	ProcessPause (UInt_t local_time, UInt_t evt_count)
void	ProcessEnd (UInt_t local_time, UInt_t evt_count)

Protected Attributes
Bool_t	fFoundControlEvents
UInt_t	fPrestartTime
UInt_t	fPrestartRunNumber
UInt_t	fRunType
UInt_t	fEndTime
UInt_t	fEndEventCount
UInt_t	fNumberPause
std::vector< UInt_t >	fPauseEventCount
std::vector< UInt_t >	fPauseTime
UInt_t	fNumberGo
std::vector< UInt_t >	fGoEventCount
std::vector< UInt_t >	fGoTime
UInt_t	fStartTime
TDatime	fPrestartDatime
TDatime	fStartDatime
TDatime	fEndDatime

Detailed Description

Mix-in class for handling CODA control event data and timing.

Provides functionality for processing and storing information from CODA control events including prestart, go, pause, and end events. Manages run timing, event counts, and run summary reporting.

Definition at line 24 of file MQwCodaControlEvent.h.

Member Enumeration Documentation

EventTypes

enum MQwCodaControlEvent::EventTypes

protected

Enumerator
kSYNC_EVENT
kPRESTART_EVENT
kGO_EVENT
kPAUSE_EVENT
kEND_EVENT

Definition at line 64 of file MQwCodaControlEvent.h.

                 {
    kSYNC_EVENT        =  16,
    kPRESTART_EVENT    =  17,
    kGO_EVENT          =  18,
    kPAUSE_EVENT       =  19,
    kEND_EVENT         =  20
  };

Constructor & Destructor Documentation

MQwCodaControlEvent()

MQwCodaControlEvent::MQwCodaControlEvent

(

)

Definition at line 10 of file MQwCodaControlEvent.cc.

                                        {
  ResetControlParameters();
}

References ResetControlParameters().

Here is the call graph for this function:

~MQwCodaControlEvent()

MQwCodaControlEvent::~MQwCodaControlEvent

(

)

Definition at line 14 of file MQwCodaControlEvent.cc.

{ }

Member Function Documentation

GetEndEventCount()

UInt_t MQwCodaControlEvent::GetEndEventCount ( )

inline

Definition at line 46 of file MQwCodaControlEvent.h.

{return fEndEventCount;};

References fEndEventCount.

GetEndSQLTime()

TString MQwCodaControlEvent::GetEndSQLTime

(

)

Definition at line 144 of file MQwCodaControlEvent.cc.

{
  return fEndDatime.AsSQLString();
}

References fEndDatime.

Referenced by ReportRunSummary().

Here is the caller graph for this function:

GetEndTime()

UInt_t MQwCodaControlEvent::GetEndTime ( )

inline

Definition at line 45 of file MQwCodaControlEvent.h.

{return fEndTime;};

References fEndTime.

Referenced by GetEndUnixTime().

Here is the caller graph for this function:

GetEndUnixTime()

time_t MQwCodaControlEvent::GetEndUnixTime

(

)

Definition at line 195 of file MQwCodaControlEvent.cc.

{
  // if GetEndTime is equal to 0
  // we will see the end time as 
  //
  UInt_t end_time       = GetEndTime();
  UInt_t qweak_end_time = 1338523199;
  // 2012-05-31 23:59:59 in the MySQL database
  // $date -d@1338523199 
  // Thu May 31 23:59:59 EDT 2012 in a xterm (Linux)
 
  if(end_time) return (time_t) end_time;
  else         return (time_t) qweak_end_time;
}

References GetEndTime().

Here is the call graph for this function:

GetGoEventCount()

UInt_t MQwCodaControlEvent::GetGoEventCount

(

int

index = 0

)

Definition at line 120 of file MQwCodaControlEvent.cc.

{
  if (index>=0 && index<(Int_t)fNumberGo) return fGoEventCount[index];
  return 0;
}

References fGoEventCount, and fNumberGo.

GetGoTime()

UInt_t MQwCodaControlEvent::GetGoTime

(

int

index = 0

)

Definition at line 114 of file MQwCodaControlEvent.cc.

{
  if (index>=0 && index<(Int_t)fNumberGo) return fGoTime[index];
  return 0;
}

References fGoTime, and fNumberGo.

GetPauseEventCount()

UInt_t MQwCodaControlEvent::GetPauseEventCount

(

int

index = 0

)

Definition at line 132 of file MQwCodaControlEvent.cc.

{
  if (index>=0 && index<(Int_t)fNumberPause) return fPauseEventCount[index];
  return 0;
}

References fNumberPause, and fPauseEventCount.

GetPauseTime()

UInt_t MQwCodaControlEvent::GetPauseTime

(

int

index = 0

)

Definition at line 126 of file MQwCodaControlEvent.cc.

{
  if (index>=0 && index<(Int_t)fNumberPause) return fPauseTime[index];
  return 0;
}

References fNumberPause, and fPauseTime.

GetPrestartRunNumber()

UInt_t MQwCodaControlEvent::GetPrestartRunNumber ( )

inline

Definition at line 36 of file MQwCodaControlEvent.h.

{return fPrestartRunNumber;};

References fPrestartRunNumber.

GetPrestartTime()

UInt_t MQwCodaControlEvent::GetPrestartTime ( )

inline

Definition at line 35 of file MQwCodaControlEvent.h.

{return fPrestartTime;};

References fPrestartTime.

GetRunType()

UInt_t MQwCodaControlEvent::GetRunType ( )

inline

Definition at line 37 of file MQwCodaControlEvent.h.

{return fRunType;};

References fRunType.

GetStartSQLTime()

TString MQwCodaControlEvent::GetStartSQLTime

(

)

Definition at line 139 of file MQwCodaControlEvent.cc.

{
  return fStartDatime.AsSQLString();
}

References fStartDatime.

Referenced by ReportRunSummary().

Here is the caller graph for this function:

GetStartTime()

UInt_t MQwCodaControlEvent::GetStartTime ( )

inline

Definition at line 34 of file MQwCodaControlEvent.h.

{return fStartTime;};

References fStartTime.

Referenced by GetStartUnixTime().

Here is the caller graph for this function:

GetStartUnixTime()

time_t MQwCodaControlEvent::GetStartUnixTime

(

)

Definition at line 189 of file MQwCodaControlEvent.cc.

{
  return (time_t) GetStartTime();
}

References GetStartTime().

Here is the call graph for this function:

ProcessControlEvent()

void MQwCodaControlEvent::ProcessControlEvent	(	UInt_t	evtype,
		UInt_t *	buffer )

Definition at line 36 of file MQwCodaControlEvent.cc.

                                                                          {
  UInt_t local_time;
  UInt_t local_evcount;
 
  local_time      = buffer[0];
  local_evcount   = buffer[2];
  if (evtype==kSYNC_EVENT){
    UInt_t local_status = buffer[1];
    ProcessSync(local_time, local_status);
  } else if (evtype==kPRESTART_EVENT){
    UInt_t local_runnumber = buffer[1];
    UInt_t local_runtype   = buffer[2];
    ProcessPrestart(local_time, local_runnumber, local_runtype);
  } else if (evtype==kGO_EVENT){
    ProcessGo(local_time, local_evcount);
  } else if (evtype==kPAUSE_EVENT){
    ProcessPause(local_time, local_evcount);
  } else if (evtype==kEND_EVENT){
    ProcessEnd(local_time, local_evcount);
  } else {
    //  This isn't a control event.
    //  Do nothing.
  }
}

References kEND_EVENT, kGO_EVENT, kPAUSE_EVENT, kPRESTART_EVENT, kSYNC_EVENT, ProcessEnd(), ProcessGo(), ProcessPause(), ProcessPrestart(), and ProcessSync().

Referenced by Coda2EventDecoder::DecodeEventIDBank(), and Coda3EventDecoder::DecodeEventIDBank().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessEnd()

void MQwCodaControlEvent::ProcessEnd ( UInt_t local_time, UInt_t evt_count )

protected

Definition at line 104 of file MQwCodaControlEvent.cc.

{
  fFoundControlEvents = kTRUE;
  //
  fEndTime       = local_time;
  fEndEventCount = evt_count;
  fEndDatime.Set(fEndTime);
}

References fEndDatime, fEndEventCount, fEndTime, and fFoundControlEvents.

Referenced by Coda2EventDecoder::EncodeEndEventHeader(), Coda3EventDecoder::EncodeEndEventHeader(), and ProcessControlEvent().

Here is the caller graph for this function:

ProcessGo()

void MQwCodaControlEvent::ProcessGo ( UInt_t local_time, UInt_t evt_count )

protected

Definition at line 91 of file MQwCodaControlEvent.cc.

{
  fFoundControlEvents = kTRUE;
  //
  fNumberGo++;
  fGoEventCount.push_back(evt_count);
  fGoTime.push_back(local_time);
  if (fNumberGo == 1){
    fStartTime = fGoTime[0];
    fStartDatime.Set(fStartTime);
  }
}

References fFoundControlEvents, fGoEventCount, fGoTime, fNumberGo, fStartDatime, and fStartTime.

Referenced by Coda2EventDecoder::EncodeGoEventHeader(), Coda3EventDecoder::EncodeGoEventHeader(), and ProcessControlEvent().

Here is the caller graph for this function:

ProcessPause()

void MQwCodaControlEvent::ProcessPause ( UInt_t local_time, UInt_t evt_count )

protected

Definition at line 82 of file MQwCodaControlEvent.cc.

{
  fFoundControlEvents = kTRUE;
  //
  fNumberPause++;
  fPauseEventCount.push_back(evt_count);
  fPauseTime.push_back(local_time);
}

References fFoundControlEvents, fNumberPause, fPauseEventCount, and fPauseTime.

Referenced by Coda2EventDecoder::EncodePauseEventHeader(), Coda3EventDecoder::EncodePauseEventHeader(), and ProcessControlEvent().

Here is the caller graph for this function:

ProcessPrestart()

void MQwCodaControlEvent::ProcessPrestart ( UInt_t local_time, UInt_t local_runnumber, UInt_t local_runtype )

protected

Definition at line 69 of file MQwCodaControlEvent.cc.

{
  fFoundControlEvents = kTRUE;
  //
  ResetControlParameters();
  //
  fPrestartTime = local_time;
  fPrestartRunNumber    = local_runnumber;
  fRunType      = local_runtype;
  fPrestartDatime.Set(fPrestartTime);
}

References fFoundControlEvents, fPrestartDatime, fPrestartRunNumber, fPrestartTime, fRunType, and ResetControlParameters().

Referenced by Coda2EventDecoder::EncodePrestartEventHeader(), Coda3EventDecoder::EncodePrestartEventHeader(), and ProcessControlEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessSync()

void MQwCodaControlEvent::ProcessSync ( UInt_t local_time, UInt_t statuscode )

protected

Definition at line 62 of file MQwCodaControlEvent.cc.

{
  fFoundControlEvents = kTRUE;
  // To be implemented...
}

References fFoundControlEvents.

Referenced by ProcessControlEvent().

Here is the caller graph for this function:

ReportRunSummary()

void MQwCodaControlEvent::ReportRunSummary

(

)

Definition at line 150 of file MQwCodaControlEvent.cc.

{
  if (fFoundControlEvents){
    //  At least one control event has been found.
    //  Report the control event data we did find.
    Int_t i;
    QwMessage << "Run Number:         " << fPrestartRunNumber << QwLog::endl;
    QwMessage << "Run Type:           " << fRunType << QwLog::endl;
    QwMessage << "PreStart Time:      " << fPrestartTime << QwLog::endl;
    QwMessage << "Start Time:         " << fStartTime << QwLog::endl;
    QwMessage << "End Time:           " << fEndTime << QwLog::endl;
    QwMessage << "End Event Counter:  " << fEndEventCount << QwLog::endl;
    if (fEndTime>0 && fStartTime>0)
      QwMessage << "Run Duration (sec): " << fEndTime-fStartTime << QwLog::endl;
    else
      QwMessage << "Run Duration (sec): " << "n/a" << QwLog::endl;
    QwMessage << "SQL-Formatted Start Time: " << GetStartSQLTime()
          << QwLog::endl; 
    QwMessage << "SQL-Formatted End Time:   " << GetEndSQLTime()
          << QwLog::endl; 
    QwMessage << "Number of Pauses during this run: " << fNumberPause 
          << QwLog::endl;
    for (i=0; i<(Int_t)fNumberPause; i++) {
      QwMessage << "Pause Number: " << i
        <<"; Events so far: " << fPauseEventCount[i] 
        << "; Runtime since start (sec): " 
        << fPauseTime[i]-fStartTime;
      if ((Int_t)fNumberGo > i+1){
    QwMessage << "; Duration of Pause (sec): " 
          << fGoTime[i+1]-fPauseTime[i]
          << QwLog::endl;
      }else {
    QwMessage << QwLog::endl;
      }
    }
  }
}

References QwLog::endl(), fEndEventCount, fEndTime, fFoundControlEvents, fGoTime, fNumberGo, fNumberPause, fPauseEventCount, fPauseTime, fPrestartRunNumber, fPrestartTime, fRunType, fStartTime, GetEndSQLTime(), GetStartSQLTime(), and QwMessage.

Here is the call graph for this function:

ResetControlParameters()

void MQwCodaControlEvent::ResetControlParameters

(

)

Definition at line 16 of file MQwCodaControlEvent.cc.

{
  fFoundControlEvents = kFALSE;
  fPrestartTime  = 0;
  fPrestartRunNumber = 0;
  fRunType       = 0;
  fEndTime       = 0;
  fEndEventCount = 0;
  fNumberPause   = 0;
  fPauseTime.clear();
  fPauseEventCount.clear();
  fNumberGo      = 0;
  fGoTime.clear();
  fGoEventCount.clear();
  fStartTime     = 0;
  fPrestartDatime.Set(UInt_t(0));
  fStartDatime.Set(UInt_t(0));
  fEndDatime.Set(UInt_t(0));
}

References fEndDatime, fEndEventCount, fEndTime, fFoundControlEvents, fGoEventCount, fGoTime, fNumberGo, fNumberPause, fPauseEventCount, fPauseTime, fPrestartDatime, fPrestartRunNumber, fPrestartTime, fRunType, fStartDatime, and fStartTime.

Referenced by MQwCodaControlEvent(), and ProcessPrestart().

Here is the caller graph for this function:

Field Documentation

fEndDatime

TDatime MQwCodaControlEvent::fEndDatime

protected

Definition at line 93 of file MQwCodaControlEvent.h.

Referenced by GetEndSQLTime(), ProcessEnd(), and ResetControlParameters().

fEndEventCount

UInt_t MQwCodaControlEvent::fEndEventCount

protected

Definition at line 80 of file MQwCodaControlEvent.h.

Referenced by GetEndEventCount(), ProcessEnd(), ReportRunSummary(), and ResetControlParameters().

fEndTime

UInt_t MQwCodaControlEvent::fEndTime

protected

Definition at line 79 of file MQwCodaControlEvent.h.

Referenced by GetEndTime(), ProcessEnd(), ReportRunSummary(), and ResetControlParameters().

fFoundControlEvents

Bool_t MQwCodaControlEvent::fFoundControlEvents

protected

Definition at line 73 of file MQwCodaControlEvent.h.

Referenced by ProcessEnd(), ProcessGo(), ProcessPause(), ProcessPrestart(), ProcessSync(), ReportRunSummary(), and ResetControlParameters().

fGoEventCount

std::vector<UInt_t> MQwCodaControlEvent::fGoEventCount

protected

Definition at line 87 of file MQwCodaControlEvent.h.

Referenced by GetGoEventCount(), ProcessGo(), and ResetControlParameters().

fGoTime

std::vector<UInt_t> MQwCodaControlEvent::fGoTime

protected

Definition at line 88 of file MQwCodaControlEvent.h.

Referenced by GetGoTime(), ProcessGo(), ReportRunSummary(), and ResetControlParameters().

fNumberGo

UInt_t MQwCodaControlEvent::fNumberGo

protected

Definition at line 86 of file MQwCodaControlEvent.h.

Referenced by GetGoEventCount(), GetGoTime(), ProcessGo(), ReportRunSummary(), and ResetControlParameters().

fNumberPause

UInt_t MQwCodaControlEvent::fNumberPause

protected

Definition at line 82 of file MQwCodaControlEvent.h.

Referenced by GetPauseEventCount(), GetPauseTime(), ProcessPause(), ReportRunSummary(), and ResetControlParameters().

fPauseEventCount

std::vector<UInt_t> MQwCodaControlEvent::fPauseEventCount

protected

Definition at line 83 of file MQwCodaControlEvent.h.

Referenced by GetPauseEventCount(), ProcessPause(), ReportRunSummary(), and ResetControlParameters().

fPauseTime

std::vector<UInt_t> MQwCodaControlEvent::fPauseTime

protected

Definition at line 84 of file MQwCodaControlEvent.h.

Referenced by GetPauseTime(), ProcessPause(), ReportRunSummary(), and ResetControlParameters().

fPrestartDatime

TDatime MQwCodaControlEvent::fPrestartDatime

protected

Definition at line 91 of file MQwCodaControlEvent.h.

Referenced by ProcessPrestart(), and ResetControlParameters().

fPrestartRunNumber

UInt_t MQwCodaControlEvent::fPrestartRunNumber

protected

Definition at line 76 of file MQwCodaControlEvent.h.

Referenced by GetPrestartRunNumber(), ProcessPrestart(), ReportRunSummary(), and ResetControlParameters().

fPrestartTime

UInt_t MQwCodaControlEvent::fPrestartTime

protected

Definition at line 75 of file MQwCodaControlEvent.h.

Referenced by GetPrestartTime(), ProcessPrestart(), ReportRunSummary(), and ResetControlParameters().

fRunType

UInt_t MQwCodaControlEvent::fRunType

protected

Definition at line 77 of file MQwCodaControlEvent.h.

Referenced by GetRunType(), ProcessPrestart(), ReportRunSummary(), and ResetControlParameters().

fStartDatime

TDatime MQwCodaControlEvent::fStartDatime

protected

Definition at line 92 of file MQwCodaControlEvent.h.

Referenced by GetStartSQLTime(), ProcessGo(), and ResetControlParameters().

fStartTime

UInt_t MQwCodaControlEvent::fStartTime

protected

Definition at line 89 of file MQwCodaControlEvent.h.

Referenced by GetStartTime(), ProcessGo(), ReportRunSummary(), and ResetControlParameters().

---

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

• MQwCodaControlEvent.h
• MQwCodaControlEvent.cc