SleepModule Class Reference
[DataUtil]

A sleepy job module. More...

#include <SleepModule.h>

Inheritance diagram for SleepModule:

List of all members.

Public Member Functions
	SleepModule ()
	~SleepModule ()
void	BeginRun ()
void	EndRun ()
void	BeginFile ()
void	EndFile ()
JobCResult	Ana (const MomNavigator *mom)
const Registry &	DefaultConfig () const

---

Detailed Description

A sleepy job module.

A module that will sleep in its Ana method for a configurable amount of time. The configuration parameter is "delay" and defaults to 1.0 seconds.

Author:

(last to touch it)

Author

bv

Version:

Revision

1.2

Date:

Date

2005/04/15 14:50:02

Contact: bv@bnl.gov

Created on: Fri Apr 15 10:46:40 2005

Id

SleepModule.h,v 1.2 2005/04/15 14:50:02 bv Exp

Definition at line 33 of file SleepModule.h.

---

Constructor & Destructor Documentation

SleepModule::SleepModule

(

)

Definition at line 19 of file SleepModule.cxx.

{
}

SleepModule::~SleepModule

(

)

Definition at line 22 of file SleepModule.cxx.

{
}

---

Member Function Documentation

JobCResult SleepModule::Ana

(

const MomNavigator *

mom

)

[virtual]

Implement this for read only access to the MomNavigator

Reimplemented from JobCModule.

Definition at line 50 of file SleepModule.cxx.

References Registry::Get(), JobCModule::GetConfig(), gSystem(), JobCResult::kAOK, Msg::kVerbose, Munits::millisecond, MSG, and timer().

{
    double delay = 1.0;
    this->GetConfig().Get("delay",delay);
    
    MSG("Sleep",Msg::kVerbose)
        << "Sleeping for " << delay/Munits::millisecond << " msec\n";
    TStopwatch timer;
    timer.Start();    
    gSystem->Sleep((int)(delay/Munits::millisecond));
    timer.Stop();
    MSG("Sleep",Msg::kVerbose)
        << "Slept for: " << timer.RealTime() << endl;
    
    return JobCResult::kAOK;
}

void SleepModule::BeginFile

(

)

[virtual]

Implement for notification of begin of file. See GetCurrentFile().

Reimplemented from JobCModule.

Definition at line 35 of file SleepModule.cxx.

References JobCModule::GetCurrentFile(), Msg::kDebug, and MSG.

{
    const char* file = this->GetCurrentFile();
    if (!file) file = "unknown";
    MSG("Sleep",Msg::kDebug)
        << " begin file:" << file << endl;
}

void SleepModule::BeginRun

(

)

[virtual]

Implement for notification of begin of run (meaningful for Daq data only). See GetCurrentRun().

Reimplemented from JobCModule.

Definition at line 26 of file SleepModule.cxx.

References Msg::kDebug, and MSG.

{
    MSG("Sleep",Msg::kDebug) << " begin run \n";
}

const Registry & SleepModule::DefaultConfig

(

)

const [virtual]

Get the default configuration registry. This should normally be overridden. One useful idiom is to implement it like:

const Registry& MyModule::DefaultConfig() const { static Registry cfg; // never is destroyed if (cfg.Size()) return cfg; // already filled it // set defaults: cfg.Set("TheAnswer",42); cfg.Set("Units","unknown"); return cfg; }

Reimplemented from JobCModule.

Definition at line 66 of file SleepModule.cxx.

References Registry::Set(), and Registry::Size().

{
    static Registry cfg;
    if (cfg.Size() == 0) {
        cfg.Set("delay",1.0);
    }
    return cfg;
}

void SleepModule::EndFile

(

)

[virtual]

Implement for notification of end of file. See GetLastFile().

Reimplemented from JobCModule.

Definition at line 42 of file SleepModule.cxx.

References JobCModule::GetCurrentFile(), Msg::kDebug, and MSG.

{
    const char* file = this->GetCurrentFile();
    if (!file) file = "unknown";
    MSG("Sleep",Msg::kDebug)
        << " end file:" << file << endl;
}

void SleepModule::EndRun

(

)

[virtual]

Implement for notification of end of run (meaningful for Daq data only). See GetLastRun().

Reimplemented from JobCModule.

Definition at line 30 of file SleepModule.cxx.

References Msg::kDebug, and MSG.

{
    MSG("Sleep",Msg::kDebug) << " end run \n";
}

---

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

• SleepModule.h
• SleepModule.cxx

---