KaliVeda
Toolkit for HIC analysis
KVRemoteAvailableRunsFile Class Reference

Detailed Description

List of available runfiles in a remote data repository.

Created by KVClassFactory on Mon May 22 00:14:11 2006 Author: John Frankland

Definition at line 22 of file KVRemoteAvailableRunsFile.h.

#include <KVRemoteAvailableRunsFile.h>

Inheritance diagram for KVRemoteAvailableRunsFile:

Public Member Functions

 KVRemoteAvailableRunsFile ()
 default Constructor More...
 
 KVRemoteAvailableRunsFile (const Char_t *type, KVDataSet *ds)
 
virtual ~ KVRemoteAvailableRunsFile ()
 
void Add (Int_t, const Char_t *)
 
void Remove (Int_t, const Char_t *="")
 
void Update (Bool_t=kFALSE)
 
- Public Member Functions inherited from KVAvailableRunsFile
 KVAvailableRunsFile ()
 Default ctor. More...
 
 KVAvailableRunsFile (const Char_t *type)
 
 KVAvailableRunsFile (const Char_t *type, const KVDataSet *parent)
 Constructor with name of datatype and pointer to dataset to which this file belongs. More...
 
virtual ~ KVAvailableRunsFile ()
 
virtual Bool_t CheckAvailable (Int_t run)
 
KVNumberList CheckMultiRunfiles ()
 Returns a list with all runs which occur more than once in the available runs file. More...
 
virtual Int_t Count (Int_t run)
 
Bool_t ExtractDateFromFileName (const Char_t *name, KVDatime &date)
 
Bool_t FileExists () const
 
const KVDataSetGetDataSet () const
 
const Char_t * GetDataType () const
 
const Char_t * GetFileName (Int_t run)
 
virtual TList * GetListOfAvailableSystems (const KVDBSystem *systol=0)
 
virtual Bool_t GetRunInfo (Int_t run, TDatime &modtime, TString &filename)
 
virtual void GetRunInfos (Int_t run, KVList *dates, KVList *names)
 
virtual KVNumberList GetRunList (const KVDBSystem *system=0)
 
virtual Bool_t InfosNeedUpdate (Int_t run, const Char_t *filename)
 
Int_t IsRunFileName (const Char_t *filename)
 
void RemoveDuplicateLines (KVNumberList lines_to_be_removed)
 
void SetDataSet (const KVDataSet *d)
 
virtual void UpdateInfos (Int_t run, const Char_t *filename, const Char_t *kvversion, const Char_t *username)
 
- 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_t * GetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObject * GetObject () const
 
virtual const Char_t * GetType () 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)
 

Private Member Functions

virtual void CloseAvailableRunsFile ()
 
void init ()
 
virtual Bool_t OpenAvailableRunsFile ()
 

Private Attributes

TString fCurl
 full path to executable used to copy files More...
 
TString fFilePath
 full path to copy of remote file kept in temp dir More...
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Static Public Member Functions inherited from KVAvailableRunsFile
static Bool_t ExtractDateFromFileName (const TString &fmt, const Char_t *name, KVDatime &date)
 
static Int_t IsRunFileName (const KVString &fmt, const Char_t *filename, Int_t index_multiplier=10, const Char_t *separators=".")
 
- 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_t * FindFile (const Char_t *search, TString &wfil)
 
static const Char_t * GetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetDATABASEFilePath ()
 
static const Char_t * GetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_t * GetDataSetEnv (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_t * GetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_t * GetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_t * GetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_t * GetKVBuildTime ()
 Returns KaliVeda build time. More...
 
static const Char_t * GetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_t * GetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_t * GetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_t * GetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_t * GetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetListOfPlugins (const Char_t *base)
 
static const Char_t * GetListOfPluginURIs (const Char_t *base)
 
static const Char_t * GetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_t * GetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_t * GetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_t * gitBranch ()
 Returns git branch of sources. More...
 
static const Char_t * gitCommit ()
 Returns last git commit of sources. More...
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandler * LoadPlugin (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, KVSQLite::database &dbfile, const Char_t *kvsubdir="")
 
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_t * WorkingDirectory ()
 

Constructor & Destructor Documentation

◆ KVRemoteAvailableRunsFile() [1/2]

KVRemoteAvailableRunsFile::KVRemoteAvailableRunsFile ( )

default Constructor

Definition at line 24 of file KVRemoteAvailableRunsFile.cpp.

◆ KVRemoteAvailableRunsFile() [2/2]

KVRemoteAvailableRunsFile::KVRemoteAvailableRunsFile ( const Char_t *  type,
KVDataSet ds 
)

Constructor with name of datatype and pointer to parent dataset

Definition at line 36 of file KVRemoteAvailableRunsFile.cpp.

◆ ~ KVRemoteAvailableRunsFile()

virtual KVRemoteAvailableRunsFile::~ KVRemoteAvailableRunsFile ( )
virtual

Member Function Documentation

◆ Add()

void KVRemoteAvailableRunsFile::Add ( Int_t  ,
const Char_t *   
)
inlinevirtual

Reimplemented from KVAvailableRunsFile.

Definition at line 46 of file KVRemoteAvailableRunsFile.h.

◆ CloseAvailableRunsFile()

void KVRemoteAvailableRunsFile::CloseAvailableRunsFile ( )
privatevirtual

Redefines KVAvailableRunsFile::CloseAvailableRunsFile We do not want to transfer the file again every time we need to read it, therefore we do not close the file, simply remove the lock.

Reimplemented from KVAvailableRunsFile.

Definition at line 164 of file KVRemoteAvailableRunsFile.cpp.

◆ init()

void KVRemoteAvailableRunsFile::init ( void  )
private

Find executable 'curl' or programme indicated by value of DataRepository.RemoteAvailableRuns.protocol

Definition at line 72 of file KVRemoteAvailableRunsFile.cpp.

◆ OpenAvailableRunsFile()

Bool_t KVRemoteAvailableRunsFile::OpenAvailableRunsFile ( )
privatevirtual

Initialise fRunlist so that it can be used to read the available runs file from the beginning.

If the file has already been opened, this means resetting the ifstream to the start of the file.

If not already open, open the file containing the list of available runs for the dataset. What this actually means is:

  • read value of DataRepository.RemoteAvailableRuns.url for the data repository
  • use 'curl' or programme indicated by value of DataRepository.RemoteAvailableRuns.protocol to make local copy of file
  • open copy Returns kFALSE in case of problems. already open ?

Reimplemented from KVAvailableRunsFile.

Definition at line 100 of file KVRemoteAvailableRunsFile.cpp.

◆ Remove()

void KVRemoteAvailableRunsFile::Remove ( Int_t  ,
const Char_t *  = "" 
)
inlinevirtual

Reimplemented from KVAvailableRunsFile.

Definition at line 38 of file KVRemoteAvailableRunsFile.h.

◆ Update()

void KVRemoteAvailableRunsFile::Update ( Bool_t  = kFALSE)
inlinevirtual

Reimplemented from KVAvailableRunsFile.

Definition at line 42 of file KVRemoteAvailableRunsFile.h.

Member Data Documentation

◆ fCurl

TString KVRemoteAvailableRunsFile::fCurl
private

full path to executable used to copy files

Definition at line 26 of file KVRemoteAvailableRunsFile.h.

◆ fFilePath

TString KVRemoteAvailableRunsFile::fFilePath
private

full path to copy of remote file kept in temp dir

Definition at line 25 of file KVRemoteAvailableRunsFile.h.