KaliVeda  1.12/06
Heavy-Ion Analysis Toolkit
List of all members | Public Member Functions | Protected Attributes | List of all members
KVBatchJob Class Reference

Handles jobs submitted to batch system.

Created by KVClassFactory on Wed Apr 3 14:15:11 2013 Author: John Frankland,,,

Definition at line 15 of file KVBatchJob.h.

Public Member Functions

 KVBatchJob ()
 Default constructor. More...
 
virtual ~KVBatchJob ()
 Destructor. More...
 
virtual void DeleteJob ()
 
Int_t GetCPUmax () const
 
virtual Int_t GetCPUusage () const
 
const Char_tGetDiskMax () const
 
const Char_tGetDiskUsed () const
 
Int_t GetEventsRead () const
 
Int_t GetEventsTotal () const
 
Int_t GetJobID () const
 
const Char_tGetMemMax () const
 
const Char_tGetMemUsed () const
 
Int_t GetPercentageComplete () const
 
const Char_tGetStatus () const
 
const KVDatimeGetSubmitted () const
 
void ls (Option_t *="") const
 
void SetCPUmax (Int_t c)
 
void SetCPUusage (Int_t m)
 
void SetDiskMax (const Char_t *m)
 
void SetDiskUsed (const Char_t *m)
 
void SetEventsRead (Int_t c)
 
void SetEventsTotal (Int_t c)
 
void SetJobID (Int_t n)
 
void SetMemMax (const Char_t *m)
 
void SetMemUsed (const Char_t *m)
 
void SetStatus (const Char_t *s)
 
void SetSubmitted (KVDatime &m)
 
virtual void UpdateDiskUsedEventsRead ()
 
- Public Member Functions inherited from KVBase
 KVBase ()
 Default constructor. More...
 
 KVBase (const Char_t *name, const Char_t *title="")
 Ctor for object with given name and type. More...
 
 KVBase (const KVBase &)
 copy ctor More...
 
virtual ~ KVBase ()
 
virtual void Clear (Option_t *opt="")
 Clear object properties : name, type/title, number, label. More...
 
virtual void Copy (TObject &) const
 Make a copy of this object. More...
 
const Char_tGetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObjectGetObject () const
 
const Char_tGetType () const
 
Bool_t HasLabel () const
 
virtual Bool_t IsCalled (const Char_t *name) const
 
Bool_t IsLabelled (const Char_t *l) const
 
virtual Bool_t IsType (const Char_t *typ) const
 
virtual void List ()
 
KVBaseoperator= (const KVBase &)
 copy assignment operator More...
 
virtual void Print (Option_t *option="") const
 
Double_t ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const
 
void SetLabel (const Char_t *lab)
 
virtual void SetNumber (UInt_t num)
 
virtual void SetType (const Char_t *str)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 
virtual TObjectClone (const char *newname="") const
 
virtual Int_t Compare (const TObject *obj) const
 
virtual void FillBuffer (char *&buffer)
 
virtual const char * GetName () const
 
virtual const char * GetTitle () const
 
virtual ULong_t Hash () const
 
virtual Bool_t IsSortable () const
 
TNamedoperator= (const TNamed &rhs)
 
virtual void SetName (const char *name)
 
virtual void SetNameTitle (const char *name, const char *title)
 
virtual void SetTitle (const char *title="")
 
virtual Int_t Sizeof () const
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 
virtual ~TObject ()
 
void AbstractMethod (const char *method) const
 
virtual void AppendPad (Option_t *option="")
 
virtual void Browse (TBrowser *b)
 
ULong_t CheckedHash ()
 
virtual const char * ClassName () const
 
virtual void Delete (Option_t *option="")
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 
virtual void Draw (Option_t *option="")
 
virtual void DrawClass () const
 
virtual TObjectDrawClone (Option_t *option="") const
 
virtual void Dump () const
 
virtual void Error (const char *method, const char *msgfmt,...) const
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 
virtual TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 
virtual Bool_t HandleTimer (TTimer *timer)
 
Bool_t HasInconsistentHash () const
 
virtual void Info (const char *method, const char *msgfmt,...) const
 
virtual Bool_t InheritsFrom (const char *classname) const
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 
virtual void Inspect () const
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 
virtual Bool_t IsFolder () const
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 
virtual Bool_t Notify ()
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 
virtual void Paint (Option_t *option="")
 
virtual void Pop ()
 
virtual Int_t Read (const char *name)
 
virtual void RecursiveRemove (TObject *obj)
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 
virtual void SetDrawOption (Option_t *option="")
 
virtual void SetUniqueID (UInt_t uid)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 

Protected Attributes

Int_t cpu_max
 
Int_t cpu_used
 
TString disk_max
 
TString disk_used
 
Int_t events_read
 
Int_t events_total
 
TString mem_max
 
TString mem_used
 
KVDatime submitted
 
- Protected Attributes inherited from KVBase
TString fLabel
 label for the object More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TObject
 kOnlyPrepStep
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- Static Public Member Functions inherited from KVBase
static Bool_t AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
 Comparison between two 64-bit floating-point values. More...
 
static void BackupFileWithDate (const Char_t *path)
 
static void CombineFiles (const Char_t *file1, const Char_t *file2, const Char_t *newfilename, Bool_t keep=kTRUE)
 
static void Deprecated (const char *method, const char *advice)
 
static Bool_t FindClassSourceFiles (const Char_t *class_name, KVString &imp_file, KVString &dec_file, const Char_t *dir_name=".")
 
static Bool_t FindExecutable (TString &exec, const Char_t *path="$(PATH)")
 
static const Char_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_tGetDataSetEnv (const Char_t *dataset, const Char_t *type, const Char_t *defval)
 
static Double_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Double_t defval)
 
static const Char_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources. More...
 
static const Char_tgitCommit ()
 Returns last git commit of sources. More...
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandlerLoadPlugin (const Char_t *base, const Char_t *uri="0")
 
static Bool_t OpenContextMenu (const char *method, TObject *obj, const char *alt_method_name="")
 
static void OpenTempFile (TString &base, std::ofstream &fp)
 
static void PrintSplashScreen ()
 Prints welcome message and infos on version etc. More...
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ifstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ofstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchKVFile (const Char_t *name, TString &fullpath, const Char_t *kvsubdir="")
 
static const Char_tWorkingDirectory ()
 
- Static Public Member Functions inherited from TObject
static Longptr_t GetDtorOnly ()
 
static Bool_t GetObjectStat ()
 
static void SetDtorOnly (void *obj)
 
static void SetObjectStat (Bool_t stat)
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 

#include <KVBatchJob.h>

Inheritance diagram for KVBatchJob:
Inheritance graph
[legend]

Constructor & Destructor Documentation

◆ KVBatchJob()

KVBatchJob::KVBatchJob ( )

Default constructor.

Definition at line 15 of file KVBatchJob.cpp.

◆ ~KVBatchJob()

KVBatchJob::~KVBatchJob ( )
virtual

Destructor.

Definition at line 31 of file KVBatchJob.cpp.

Member Function Documentation

◆ DeleteJob()

virtual void KVBatchJob::DeleteJob ( )
inlinevirtual

Reimplemented in KVGEBatchJob.

Definition at line 123 of file KVBatchJob.h.

◆ GetCPUmax()

Int_t KVBatchJob::GetCPUmax ( ) const
inline

Definition at line 75 of file KVBatchJob.h.

◆ GetCPUusage()

virtual Int_t KVBatchJob::GetCPUusage ( ) const
inlinevirtual

Reimplemented in KVGEBatchJob.

Definition at line 59 of file KVBatchJob.h.

◆ GetDiskMax()

const Char_t* KVBatchJob::GetDiskMax ( ) const
inline

Definition at line 91 of file KVBatchJob.h.

◆ GetDiskUsed()

const Char_t* KVBatchJob::GetDiskUsed ( ) const
inline

Definition at line 99 of file KVBatchJob.h.

◆ GetEventsRead()

Int_t KVBatchJob::GetEventsRead ( ) const
inline

Definition at line 115 of file KVBatchJob.h.

◆ GetEventsTotal()

Int_t KVBatchJob::GetEventsTotal ( ) const
inline

Definition at line 107 of file KVBatchJob.h.

◆ GetJobID()

Int_t KVBatchJob::GetJobID ( ) const
inline

Definition at line 47 of file KVBatchJob.h.

◆ GetMemMax()

const Char_t* KVBatchJob::GetMemMax ( ) const
inline

Definition at line 83 of file KVBatchJob.h.

◆ GetMemUsed()

const Char_t* KVBatchJob::GetMemUsed ( ) const
inline

Definition at line 67 of file KVBatchJob.h.

◆ GetPercentageComplete()

Int_t KVBatchJob::GetPercentageComplete ( ) const
inline

Definition at line 119 of file KVBatchJob.h.

◆ GetStatus()

const Char_t* KVBatchJob::GetStatus ( ) const
inline

Definition at line 31 of file KVBatchJob.h.

◆ GetSubmitted()

const KVDatime& KVBatchJob::GetSubmitted ( ) const
inline

Definition at line 39 of file KVBatchJob.h.

◆ ls()

void KVBatchJob::ls ( Option_t = "") const
virtual

Reimplemented from TNamed.

Definition at line 40 of file KVBatchJob.cpp.

◆ SetCPUmax()

void KVBatchJob::SetCPUmax ( Int_t  c)
inline

Definition at line 71 of file KVBatchJob.h.

◆ SetCPUusage()

void KVBatchJob::SetCPUusage ( Int_t  m)
inline

Definition at line 55 of file KVBatchJob.h.

◆ SetDiskMax()

void KVBatchJob::SetDiskMax ( const Char_t m)
inline

Definition at line 87 of file KVBatchJob.h.

◆ SetDiskUsed()

void KVBatchJob::SetDiskUsed ( const Char_t m)
inline

Definition at line 95 of file KVBatchJob.h.

◆ SetEventsRead()

void KVBatchJob::SetEventsRead ( Int_t  c)
inline

Definition at line 111 of file KVBatchJob.h.

◆ SetEventsTotal()

void KVBatchJob::SetEventsTotal ( Int_t  c)
inline

Definition at line 103 of file KVBatchJob.h.

◆ SetJobID()

void KVBatchJob::SetJobID ( Int_t  n)
inline

Definition at line 51 of file KVBatchJob.h.

◆ SetMemMax()

void KVBatchJob::SetMemMax ( const Char_t m)
inline

Definition at line 79 of file KVBatchJob.h.

◆ SetMemUsed()

void KVBatchJob::SetMemUsed ( const Char_t m)
inline

Definition at line 63 of file KVBatchJob.h.

◆ SetStatus()

void KVBatchJob::SetStatus ( const Char_t s)
inline

Definition at line 35 of file KVBatchJob.h.

◆ SetSubmitted()

void KVBatchJob::SetSubmitted ( KVDatime m)
inline

Definition at line 43 of file KVBatchJob.h.

◆ UpdateDiskUsedEventsRead()

void KVBatchJob::UpdateDiskUsedEventsRead ( )
virtual

We look for a TEnv file in the user's $HOME directory with the name [jobname].status

Definition at line 53 of file KVBatchJob.cpp.

Member Data Documentation

◆ cpu_max

Int_t KVBatchJob::cpu_max
protected

Definition at line 20 of file KVBatchJob.h.

◆ cpu_used

Int_t KVBatchJob::cpu_used
protected

Definition at line 18 of file KVBatchJob.h.

◆ disk_max

TString KVBatchJob::disk_max
protected

Definition at line 22 of file KVBatchJob.h.

◆ disk_used

TString KVBatchJob::disk_used
protected

Definition at line 23 of file KVBatchJob.h.

◆ events_read

Int_t KVBatchJob::events_read
protected

Definition at line 25 of file KVBatchJob.h.

◆ events_total

Int_t KVBatchJob::events_total
protected

Definition at line 24 of file KVBatchJob.h.

◆ mem_max

TString KVBatchJob::mem_max
protected

Definition at line 21 of file KVBatchJob.h.

◆ mem_used

TString KVBatchJob::mem_used
protected

Definition at line 19 of file KVBatchJob.h.

◆ submitted

KVDatime KVBatchJob::submitted
protected

Definition at line 17 of file KVBatchJob.h.


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