Introduction

The PROOF system exposes two API classes to the client. Here is a description, aiming to spot deficiencies and/or redundancies.

TVirtualProof

The header file defining this class can be found in here.

The public methods are:

General methods

1. TVirtualProof(const char *masterurl, const char *config, const char *confdir, Int_t loglevel)
   Constructor signature
2. virtual void cd(Int_t)
   Sets the default PROOF session; in the future this should change to the PROOF shell, where each command is executed on the cluster
3. virtual void SetAlias(const char *alias="")
   
4. virtual Int_t Ping()
   
5. virtual Int_t SetParallel(Int_t nodes)
   
6. virtual void SetLogLevel(Int_t level, UInt_t mask)
   
7. virtual void Close(Option_t *option)
   
8. virtual void Print(Option_t *option) const
   

1. virtual Int_t AddDynamicPath(const char *libpath)
   
2. virtual Int_t AddIncludePath(const char *incpath)
   
3. virtual Int_t RemoveDynamicPath(const char *libpath)
   
4. virtual Int_t RemoveIncludePath(const char *incpath)
   

Processing

1. virtual Int_t Exec(const char *cmd, Bool_t plusMaster = kFALSE)
   
2. virtual Long64_t Process(TDSet *set, const char *selector, Option_t *opt, Long64_t nentries, Long64_t first, TEventList *evl)
   
3. virtual Long64_t DrawSelect(TDSet *set, const char *varexp, const char *sel, Option_t *opt, Long64_t nentries, Long64_t first)
   

Query result management

1. virtual Int_t Archive(Int_t query, const char *url)
   
2. virtual Int_t Archive(const char *queryref, const char *url)
   
3. virtual Int_t CleanupSession(const char *sessiontag)
   
4. virtual Int_t Finalize(Int_t qry = -1, Bool_t force)
   
5. virtual Int_t Finalize(const char *queryref, Bool_t force)
   
6. virtual Int_t Remove(Int_t query)
   
7. virtual Int_t Remove(const char *queryref, Bool_t all)
   
8. virtual Int_t Retrieve(Int_t query, const char *path)
   
9. virtual Int_t Retrieve(const char *queryref, const char *path)
   

Process control

1. virtual void StopProcess(Bool_t abort, Int_t timeout)
   
2. virtual void AddInput(TObject *obj)
   
3. virtual void ClearInput()
   
4. virtual TObject *!GetOutput(const char *name)
   
5. virtual TList *!GetOutputList()
   

1. virtual Int_t SetParallel(Int_t nodes)
   
2. virtual void SetLogLevel(Int_t level, UInt_t mask)
   

1. virtual void Close(Option_t *option)
   
2. virtual void Print(Option_t *option) const
   

Cache and package management

1. virtual void ShowCache(Bool_t all)
   
2. virtual void ClearCache()
   
3. virtual TList *!GetListOfPackages()
   
4. virtual TList *!GetListOfEnabledPackages()
   
5. virtual void ShowPackages(Bool_t all)
   
6. virtual void ShowEnabledPackages(Bool_t all)
   
7. virtual Int_t ClearPackages()
   
8. virtual Int_t ClearPackage(const char *package)
   
9. virtual Int_t EnablePackage(const char *package)
   
10. virtual Int_t UploadPackage(const char *par, EUploadPackageOpt opt)
    

Dataset management

1. virtual Int_t UploadDataSet(const char *dataset, const char *files, const char *dest, Int_t opt, TList *skippedFiles)
   
2. virtual Int_t UploadDataSet(const char *dataset, TList *files, const char *dest, Int_t opt, TList *skippedFiles)
   
3. virtual Int_t UploadDataSetFromFile(const char *dataset, const char *file, const char *dest, Int_t opt)
   
4. virtual Int_t CreateDataSet(const char *dataset, TList *files, Int_t opt)
   
5. virtual TList *!GetDataSets(const char *dir)
   
6. virtual void ShowDataSets(const char * dir)
   
7. virtual void ShowDataSet(const char *dataset)
   
8. virtual Int_t RemoveDataSet(const char *dateset)
   
9. virtual Int_t VerifyDataSet(const char *dataset)
   
10. virtual TList *!GetDataSet(const char *dataset)
    

1. virtual const char *!GetMaster() const
   
2. virtual const char *!GetConfDir() const
   
3. virtual const char *!GetConfFile() const
   
4. virtual const char *!GetUser() const
   
5. virtual const char *!GetWorkDir() const
   
6. virtual const char *!GetSessionTag() const
   
7. virtual const char *!GetImage() const
   
8. virtual const char *!GetUrl()
   
9. virtual Int_t GetPort() const
   
10. virtual Int_t GetRemoteProtocol() const
    
11. virtual Int_t GetClientProtocol() const
    
12. virtual Int_t GetStatus() const
    
13. virtual Int_t GetLogLevel() const
    
14. virtual Int_t GetParallel() const
    
15. virtual Int_t GetSessionID() const
    
16. virtual TList *!GetSlaveInfo()
    

1. virtual EQueryMode GetQueryMode() const
   
2. virtual void SetQueryType(EQueryMode mode)
   

1. virtual TVirtualProofMgr::!EServType GetServType() const
   

1. virtual Long64_t GetBytesRead() const
   
2. virtual Float_t GetRealTime() const
   
3. virtual Float_t GetCpuTime() const
   

1. virtual Bool_t IsProofd() const
   
2. virtual Bool_t IsMaster() const
   
3. virtual Bool_t IsValid() const
   
4. virtual Bool_t IsParallel() const
   
5. virtual Bool_t IsDataReady(Long64_t &totalbytes, Long64_t &bytesready)
   
6. virtual Bool_t IsIdle() const
   

1. virtual void AddFeedback(const char *name)
   
2. virtual void RemoveFeedback(const char *name)
   
3. virtual void ClearFeedback()
   
4. virtual void ShowFeedback() const
   
5. virtual TList *!GetFeedbackList() const
   

1. virtual TList *!GetListOfQueries(Option_t *opt = "")
   
2. virtual Int_t GetNumberOfQueries()
   
3. virtual Int_t GetNumberOfDrawQueries()
   
4. virtual TList *!GetQueryResults()
   
5. virtual TQueryResult *!GetQueryResult(const char *ref)
   
6. virtual void GetMaxQueries()
   
7. virtual void SetMaxDrawQueries(Int_t max)
   
8. virtual void ShowQueries(Option_t *opt = "")
   

1. virtual void SetActive(Bool_t active)
   

Signals

1. virtual void LogMessage(const char *msg, Bool_t all)
   
2. virtual void Progress(Long64_t total, Long64_t processed)
   
3. virtual void Feedback(TList *objs)
   
4. virtual void QueryResultReady(const char *ref)
   
5. virtual void CloseProgressDialog()
   
6. virtual void ResetProgressDialog(const char *sel, Int_t sz, Long64_t fst, Long64_t ent)
   
7. virtual void StartupMessage(const char *msg, Bool_t status, Int_t done, Int_t total)
   
8. virtual void DataSetStatus(const char *msg, Bool_t status, Int_t done, Int_t total)
   

1. virtual void SendDataSetStatus(const char *msg, UInt_t n, UInt_t tot, Bool_t st)
   

1. virtual void GetLog(Int_t start, Int_t end)
   
2. virtual void PutLog(TQueryResult *qr)
   
3. virtual void ShowLog(Int_t qry)
   
4. virtual void ShowLog(const char *queryref)
   
5. virtual Bool_t SendingLogToWindow() const
   
6. virtual void SendLogToWindow(Bool_t mode)
   

1. virtual void ResetProgressDialogStatus()
   

1. virtual TTree !GetTreeHeader(TDSet dset)
   
2. virtual TList *!GetOutputNames()
   

1. virtual void AddChain(TChain* chain)
   
2. virtual void RemoveChain(TChain* chain)
   

1. virtual TDrawFeedback *!CreateDrawFeedback()
   
2. virtual void SetDrawFeedbackOption(TDrawFeedback *f, Option_t *opt)
   
3. virtual void DeleteDrawFeedback(TDrawFeedback *f)
   

1. virtual void Detach(Option_t *)
   

1. virtual TVirtualProofMgr *!GetManager()
   
2. virtual void SetManager(TVirtualProofMgr *mgr)
   

1. virtual void ActivateWorker(const char *ord)
   
2. virtual void DeactivateWorker(const char *ord)
   

1. virtual const char *!GetDataPoolUrl() const
   
2. virtual void SetDataPoolUrl(const char *url)
   

1. static void SetTProofHook(TProof_t proofhook)
   
2. static TProof_t GetTProofHook()
   

Static methods

1. static TVirtualProof *Open(const char *url, const char *conffile, const char *confdir, Int_t loglevel)
   
2. static Int_t Reset(const char *url, const char *usr)
   

TVirtualProofMgr

The header file defining this class can be found in here.

-- GerardoGanis - 26 Sep 2006