loon: JobCModule Class Reference

00023 : fName(""), fConfig(false), fPath(0) { }

00203 {
00204 //======================================================================
00205 // Purpose: Dummy Ana method
00206 //======================================================================
00207   MSG("JobC", Msg::kError) << gsMessage << "'Ana'\n";
00208   return JobCResult::kError;
00209 }

00073                            {
00074   MSG("JobC",Msg::kDebug) << 
00075     "JobCModule::BeginFile for module " << this->GetName() << "\n";
00076 }

00059                           {
00060   MSG("JobC",Msg::kDebug) << 
00061     "JobCModule::BeginJob for module " << this->GetName() << "\n";
00062 }

00088 {
00089   MSG("JobC",Msg::kDebug) << 
00090     "JobCModule::BeginRun for module " << this->GetName() << "\n";
00091 }

00225 {
00226 //======================================================================
00227 // Pass commands through like this for now...
00228 //======================================================================
00229   JobCommand c(cmd);
00230   this->HandleCommand(&c);
00231 }

00166 {
00167   MSG("JobC",Msg::kDebug) << 
00168     "JobCModule::Config for module " << this->GetName() << "\n";
00169   
00170   // The default config command just does a copy...
00171   bool islocked = this->GetConfig().ValuesLocked();
00172   if (islocked) this->GetConfig().UnLockValues();
00173   this->GetConfig() = r;
00174   if (islocked) this->GetConfig().LockValues();  
00175 }

00155 {
00156   MSG("JobC",Msg::kDebug) << 
00157     "JobCModule::DefaultConfig for module " << this->GetName() << "\n";
00158 
00159   static const Registry r; // Empty...
00160   return r;
00161 }

00080                          {
00081   MSG("JobC",Msg::kDebug) << 
00082     "JobCModule::EndFile for module " << this->GetName() << "\n";
00083 }

00066                         {
00067   MSG("JobC",Msg::kDebug) << 
00068     "JobCModule::End for module " << this->GetName() << "\n";
00069 }

00096 {
00097   MSG("JobC",Msg::kDebug) << 
00098     "JobCModule::EndRun for module " << this->GetName() << "\n";
00099 }

00181 {
00182 //======================================================================
00183 // Purpose: Dummy Get method
00184 //======================================================================
00185   MSG("JobC", Msg::kError) << gsMessage << "'Get'\n";
00186   return JobCResult::kError;
00187 }

00350 { 
00351 //======================================================================
00352 // This is a faily subtle point. Module's may wish to overwrite which
00353 // Registry holds their configuration. Support that with this virtual
00354 // function. Notice that the code above never nevers to fConfig but
00355 // always to this->GetConfig(). For an example of a mode that makes
00356 // use of this see JobCInput module.
00357 //======================================================================
00358   return fConfig; 
00359 }

00139 {
00140     JobCInputModule* m = GetJobCInputModule();
00141     if (!m) return "";
00142     return m->GetCurrentFile(streamname);
00143 }

00123 {
00124     JobCInputModule* m = GetJobCInputModule();
00125     if (!m) return -1;
00126     return m->GetCurrentRun();
00127 }

00104 {
00105   if (!fPath) {
00106     MSG("JobC",Msg::kWarning)
00107       << fName << " has no associated JobCPath" << endl;
00108     return 0;
00109   }     
00110   JobCInputModule* m = fPath->GetInputModule();
00111   if (!m) {
00112     MSG("JobC",Msg::kWarning)
00113       << "the associated path for " << fName
00114       << " has no input module" << endl;
00115     return 0;
00116   }
00117   return m;
00118 }

00146 {
00147     JobCInputModule* m = GetJobCInputModule();
00148     if (!m) return "";
00149     return m->GetLastFile(streamname);
00150 }

00130 {
00131     JobCInputModule* m = GetJobCInputModule();
00132     if (!m) return -1;
00133     return m->GetLastRun();
00134 }

00048 { return fName.c_str(); }

00174 { return fPath; }

00051 {
00052     const char* name=0;
00053     if (!fConfig.Get("UniqueName",name)) return 0;
00054     return name;
00055 }

00236 {
00237 //======================================================================
00238 // Warn users that this module does not implement HandleCommand
00239 //======================================================================
00240   if (command) {
00241     MSG("JobC", Msg::kWarning) 
00242       << gsMessage << "'HandleCommand': " << command->PopCmd() << endl;
00243   }
00244   else {
00245     MSG("JobC", Msg::kWarning) << gsMessage << "'HandleCommand':\n";
00246   }
00247 }

00252 {
00253 //======================================================================
00254 // Warn users that this module does not implement Help
00255 //======================================================================
00256   MSG("JobC", Msg::kWarning) << 
00257     "No help available for module '" << this->GetName() << "'\n";
00258 }

00028 {
00029   fName = name;
00030   
00031   // Configure the module with the defaults
00032   // "=" doesn't affect the name of the registry...
00033   Registry r = this->DefaultConfig();
00034   this->GetConfig().UnLockValues();
00035   this->GetConfig() = r;
00036   this->GetConfig().SetName(r.GetName());
00037   this->Config(this->GetConfig());
00038 
00039   this->GetConfig().LockKeys();
00040 }

00192 {
00193 //======================================================================
00194 // Purpose: Dummy Put method
00195 //======================================================================
00196   MSG("JobC", Msg::kError) << gsMessage << "'Put'\n";
00197   return JobCResult::kError;
00198 }

00214 {
00215 //======================================================================
00216 // Purpose: Dummy Reco method
00217 //======================================================================
00218   MSG("JobC", Msg::kError) << gsMessage << "'Reco'\n";
00219   return JobCResult::kError;
00220 }

00263 {
00264 //======================================================================
00265 // The default report command prints the module configuration
00266 //======================================================================
00267   MsgStream& m = MSGSTREAM("JobCReport",Msg::kInfo);
00268   m << this->GetName() << " configured with: " << std::endl;
00269   this->GetConfig().PrettyPrint(std::cout);
00270 }

00275 {
00276   // Reset restores the module to its original configuration
00277   this->Config(this->DefaultConfig());
00278 }

00308 {
00309 //======================================================================
00310 // Change the module's configuration using a dialog object
00311 //======================================================================
00312   bool deleted = false; // Delete dialog it before return?
00313   if (d == 0) {
00314     d = new JobCDialog();
00315     deleted = true;
00316   }
00317   
00318   // Set up d with the module's configuration parameters
00319   d->SetDefault(this->DefaultConfig());
00320   d->SetCurrent(this->GetConfig());
00321 
00322   // Do the querry...
00323   Registry r = d->Querry();
00324   
00325   // Set the module config
00326   this->GetConfig().UnLockValues();
00327   this->GetConfig().Merge(r);
00328   this->GetConfig().LockValues();
00329 
00330   this->Config(this->GetConfig());
00331   
00332   // Clean up
00333   if (deleted) { delete d; d=0; }
00334 }

00283 { 
00284 //======================================================================
00285 // The "Set" command takes a string of the format:
00286 //
00287 // Set("a=1 b=2.0 c=4.0e9 d=astring.option e='another string option'");
00288 //======================================================================
00289   // Build a command like "Set a=1 b=2";
00290   Registry r;
00291   JobCommand::StringToRegistry(r,s);
00292 
00293   // Reset the values in the module's config.
00294   this->GetConfig().UnLockValues();
00295   this->GetConfig().Merge(r);
00296   this->GetConfig().LockValues();
00297 
00298   // Pass the reconfigure signal off to the module
00299   this->Config(this->GetConfig()); // Pass the whole config 
00300                                    // safest but wasteful
00301 
00302   // this->Config(r);    // Pass just the updated values.
00303 }

00175 { fPath = path; }

00338 {
00339     if (fConfig.KeyExists("UniqueName")) return false;
00340     bool locked = fConfig.KeysLocked();
00341     fConfig.UnLockKeys();
00342     fConfig.Set("UniqueName",name);
00343     if (locked) fConfig.LockKeys();
00344     return true;
00345 }


Public Member Functions
	JobCModule ()
virtual	~JobCModule ()
const char *	GetName () const
virtual JobCResult	Ana (const MomNavigator *mom)
virtual JobCResult	Reco (MomNavigator *mom)
virtual void	BeginJob ()
virtual void	EndJob ()
virtual void	BeginFile ()
virtual void	EndFile ()
virtual void	BeginRun ()
virtual void	EndRun ()
Int_t	GetCurrentRun () const
Int_t	GetLastRun () const
const char *	GetCurrentFile (const char streamname="") const
const char *	GetLastFile (const char streamname="") const
virtual const Registry &	DefaultConfig () const
virtual void	Config (const Registry &r)
virtual JobCResult	Get (MomNavigator *mom)
virtual JobCResult	Put (const MomNavigator *mom)
virtual void	Cmd (const char *command)
virtual void	HandleCommand (JobCommand *command)
virtual void	Help ()
virtual void	Report ()
virtual void	Reset ()
void	Init (const char *name)
void	Set (const char *paramlist)
void	Set (JobCDialog *d=0)
virtual Registry &	GetConfig ()
bool	SetUniqueName (const char *name)
const char *	GetUniqueName () const
JobCPath *	GetPath ()
void	SetPath (JobCPath *path)
Private Member Functions
JobCInputModule *	GetJobCInputModule () const
Private Attributes
std::string	fName
Registry	fConfig
JobCPath *	fPath

JobCModule Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation