QwParameterFile Class Reference

#include <QwParameterFile.h>

Public Member Functions
	QwParameterFile (const std::string &filename)
	QwParameterFile (const std::stringstream &stream)
virtual	~QwParameterFile ()
std::streambuf *	rdbuf () const
	Access the streambuf pointer in the same way as on a std::ifstream. More...
void	SetCommentChars (const std::string value)
	Set various sets of special characters. More...
void	SetWhitespaceChars (const std::string value)
void	SetTokenSepChars (const std::string value)
void	SetSectionChars (const std::string value)
void	SetModuleChars (const std::string value)
Bool_t	ReadNextLine ()
Bool_t	ReadNextLine (std::string &varvalue)
Bool_t	ReadNextLine_Greedy (std::string &varvalue)
Bool_t	ReadNextLine_Single (std::string &varvalue)
void	TrimWhitespace (TString::EStripType head_tail=TString::kBoth)
void	TrimComment (const char commentchar)
void	TrimComment (const std::string &commentchars)
void	TrimComment ()
void	TrimSectionHeader ()
void	TrimModuleHeader ()
TString	LastString (TString in, char *delim)
TString	GetParameterFileContents ()
Bool_t	LineIsEmpty ()
Bool_t	IsEOF ()
std::string	GetNextToken (const std::string &separatorchars)
	Get next token as a string. More...
std::string	GetNextToken ()
template<typename T >
T	GetTypedNextToken ()
	Get next token into specific type. More...
std::string	GetLine ()
void	AddLine (const std::string &line)
void	RewindToFileStart ()
void	RewindToLineStart ()
Bool_t	HasValue (TString &vname)
Bool_t	HasVariablePair (const std::string &separatorchars, std::string &varname, std::string &varvalue)
Bool_t	HasVariablePair (const std::string &separatorchars, TString &varname, TString &varvalue)
Bool_t	FileHasVariablePair (const std::string &separatorchars, const std::string &varname, std::string &varvalue)
Bool_t	FileHasVariablePair (const std::string &separatorchars, const TString &varname, TString &varvalue)
Bool_t	LineHasSectionHeader ()
Bool_t	LineHasSectionHeader (std::string &secname)
Bool_t	LineHasSectionHeader (TString &secname)
Bool_t	LineHasModuleHeader ()
Bool_t	LineHasModuleHeader (std::string &secname)
Bool_t	LineHasModuleHeader (TString &secname)
Bool_t	FileHasSectionHeader (const std::string &secname)
Bool_t	FileHasSectionHeader (const TString &secname)
Bool_t	FileHasModuleHeader (const std::string &secname)
Bool_t	FileHasModuleHeader (const TString &secname)
Bool_t	SkipSection (std::string secname)
	Skips from the beginning of the section 'secname' until the first section that does not have that name. More...
QwParameterFile *	ReadSectionPreamble ()
	Rewinds to the start and read until it finds next section header. More...
QwParameterFile *	ReadUntilNextSection (const bool add_current_line=false)
QwParameterFile *	ReadNextSection (std::string &secname, const bool keep_header=false)
QwParameterFile *	ReadNextSection (TString &secname, const bool keep_header=false)
QwParameterFile *	ReadNextSection (const bool keep_header=false)
QwParameterFile *	ReadModulePreamble ()
	Rewinds to the start and read until it finds next module header. More...
QwParameterFile *	ReadUntilNextModule (const bool add_current_line=false)
QwParameterFile *	ReadNextModule (std::string &secname, bool keep_header=false)
QwParameterFile *	ReadNextModule (TString &secname, bool keep_header=false)
QwParameterFile *	ReadNextModule (const bool keep_header=false)
const TString	GetParamFilename ()
const TString	GetParamFilenameAndPath ()
const std::pair< TString, TString >	GetParamFileNameContents ()
void	SetParamFilename ()
void	EnableGreediness ()
void	DisableGreediness ()
void	AddBreakpointKeyword (std::string keyname)
void	Close ()
Bool_t	HasNewPairs ()
template<typename T >
Bool_t	ReturnValue (const std::string keyname, T &retvalue)
template<typename T >
Bool_t	PopValue (const std::string keyname, T &retvalue)
template<typename T >
T	ConvertValue (const std::string &value)
	Convert string value into specific type. More...
template<>
UInt_t	ConvertValue (const std::string &value)
template<>
TString	ConvertValue (const std::string &value)

Static Public Member Functions
static UInt_t	GetUInt (const TString &varvalue)
static void	AppendToSearchPath (const TString &searchdir)
	Add a directory to the search path. More...
static void	SetCurrentRunNumber (const UInt_t runnumber)
	Set the current run number for looking up the appropriate parameter file. More...
static std::pair< int, int >	ParseIntRange (const std::string &separatorchars, const std::string &range)
	Parse a range of integers as #:# where either can be missing. More...

Protected Member Functions
void	Trim (const std::string &chars, std::string &token, TString::EStripType head_tail=TString::kBoth)
void	TrimWhitespace (std::string &token, TString::EStripType head_tail)
Bool_t	GetKeyValue (const std::string keyname, std::string &retvalue, Bool_t should_erase=kFALSE)
	Current position in the line. More...

Protected Attributes
std::string	fCommentChars
std::string	fWhitespaceChars
std::string	fTokenSepChars
std::string	fSectionChars
std::string	fModuleChars
const std::string	fFilename
std::ifstream	fFile
std::stringstream	fStream
std::string	fLine
size_t	fCurrentPos
	Internal line storage. More...
Bool_t	fBeGreedy
std::set< std::string >	fBreakpointWords
std::map< std::string, std::string >	fKeyValuePair
Bool_t	fHasNewPairs

Static Protected Attributes
static std::vector< bfs::path >	fSearchPaths
static UInt_t	fCurrentRunNumber = 0
static const std::string	kDefaultCommentChars = "#!;"
static const std::string	kDefaultWhitespaceChars = " \t\r"
static const std::string	kDefaultTokenSepChars = ", \t"
static const std::string	kDefaultSectionChars = "[]"
static const std::string	kDefaultModuleChars = "<>"

Private Member Functions
int	FindFile (const bfs::path &dir_path, const std::string &file_stem, const std::string &file_ext, bfs::path &path_found)
	Find the first file in a directory that conforms to the run label. More...
bool	OpenFile (const bfs::path &path_found)
	Open a file. More...
	QwParameterFile ()
	QwParameterFile (const QwParameterFile &input)
void	SetEOF ()

Private Attributes
TString	fBestParamFileName
TString	fBestParamFileNameAndPath

Friends
std::ostream &	operator<< (std::ostream &stream, const QwParameterFile &file)

Detailed Description

Definition at line 43 of file QwParameterFile.h.

Constructor & Destructor Documentation

QwParameterFile::QwParameterFile

(

const std::string &

name

)

Constructor

Parameters

name	Name of the file to be opened

If file starts with an explicit slash ('/'), it is assumed to be a full path.

Definition at line 111 of file QwParameterFile.cc.

References QwLog::endl(), FindFile(), fSearchPaths, Qw::kGreen, Qw::kNormal, OpenFile(), QwError, QwMessage, QwWarning, and SetEOF().

: fCommentChars(kDefaultCommentChars),
  fWhitespaceChars(kDefaultWhitespaceChars),
  fTokenSepChars(kDefaultTokenSepChars),
  fSectionChars(kDefaultSectionChars),
  fModuleChars(kDefaultModuleChars),
  fFilename(name),
  fBeGreedy(kFALSE)
{
  // Create a file from the name
  bfs::path file(name);

  // Immediately try to open absolute paths and return
  if (name.find("/") == 0) {
    if (OpenFile(file) == false) {
      QwWarning << "Could not open absolute path " << name << ". "
                << "Parameter file will remain empty." << QwLog::endl;
      SetEOF();
      return;
    }

    // Print file name of file that was used
    QwMessage << "Parameter file: "
              << QwColor(Qw::kGreen)  << file.string()
              << QwColor(Qw::kNormal) << QwLog::endl;

    // Else, loop through search path and files
  } else {

#if BOOST_VERSION >= 104600
    // Separate file in stem and extension
    std::string file_stem = file.stem().string();
    std::string file_ext = file.extension().string();
#elif BOOST_VERSION >= 103600
    // Separate file in stem and extension
    std::string file_stem = file.stem();
    std::string file_ext = file.extension();
#else
    // Separate file in stem and extension
    std::string file_stem = bfs::basename(file);
    std::string file_ext = bfs::extension(file);
#endif

    // Find the best match
    Int_t best_score = 0;
    bfs::path best_path;
    for (size_t i = 0; i < fSearchPaths.size(); i++) {

      bfs::path path;
      Int_t score = FindFile(fSearchPaths[i], file_stem, file_ext, path);
      if (score > best_score) {
        // Found file with better score
        best_score = score;
        best_path  = path;
      } else if (score == best_score) {
        // Found file with identical score
        QwWarning << "Equally likely parameter files encountered: " << best_path.string()
                  << " and " << path.string() << QwLog::endl;
        QwMessage << "Analysis will use parameter file: " << best_path.string()
                  << QwLog::endl;
      }
    } // end of loop over search paths

    // File not found
    if (best_score == 0) {
      QwError << "Could not find any parameter file with name " << name << ". "
              << "Parameter file will remain empty." << QwLog::endl;
      SetEOF();
      exit(-1);
      return;
    }

    // Found but unable to open
    if (best_score > 0 && OpenFile(best_path) == false) {
      QwError << "Could not open parameter file " << best_path.string() << ". "
              << "Parameter file will remain empty." << QwLog::endl;
      SetEOF();
      exit(-1);
      return;
    }

    // Print file name of file that was used
    QwMessage << "Parameter file: "
              << QwColor(Qw::kGreen)  << best_path.string()
              << QwColor(Qw::kNormal) << QwLog::endl;
  }
}

Here is the call graph for this function:

QwParameterFile::QwParameterFile

(

const std::stringstream &

stream

)

Constructor

Parameters

stream

String stream for reading

Definition at line 92 of file QwParameterFile.cc.

References fStream.

: fCommentChars(kDefaultCommentChars),
  fWhitespaceChars(kDefaultWhitespaceChars),
  fTokenSepChars(kDefaultTokenSepChars),
  fSectionChars(kDefaultSectionChars),
  fModuleChars(kDefaultModuleChars),
  fFilename("stream"),
  fBeGreedy(kFALSE)
{
  fStream << stream.rdbuf();
}

virtual QwParameterFile::~QwParameterFile ( )

inlinevirtual

Definition at line 53 of file QwParameterFile.h.

{ };

QwParameterFile::QwParameterFile ( )

inlineprivate

Definition at line 332 of file QwParameterFile.h.

Referenced by ReadUntilNextModule(), and ReadUntilNextSection().

    : fCommentChars(kDefaultCommentChars),
      fWhitespaceChars(kDefaultWhitespaceChars),
      fTokenSepChars(kDefaultTokenSepChars),
      fSectionChars(kDefaultSectionChars),
      fModuleChars(kDefaultModuleChars),
      fFilename("empty"),
      fCurrentPos(0),
      fBeGreedy(kFALSE),
      fHasNewPairs(kFALSE)
    { };

Here is the caller graph for this function:

QwParameterFile::QwParameterFile ( const QwParameterFile &  input )

inlineprivate

Definition at line 345 of file QwParameterFile.h.

    : fCommentChars(input.fCommentChars),
      fWhitespaceChars(input.fWhitespaceChars),
      fTokenSepChars(input.fTokenSepChars),
      fSectionChars(input.fSectionChars),
      fModuleChars(input.fModuleChars),
      fFilename(input.fFilename),
      fCurrentPos(input.fCurrentPos),
      fBeGreedy(input.fBeGreedy),
      fHasNewPairs(input.fHasNewPairs)
    { };

Member Function Documentation

void QwParameterFile::AddBreakpointKeyword

(

std::string

keyname

)

Definition at line 876 of file QwParameterFile.cc.

References fBreakpointWords.

                                                            {
  std::transform(keyname.begin(), keyname.end(),
     keyname.begin(), ::tolower);
  fBreakpointWords.insert(keyname);
}

void QwParameterFile::AddLine ( const std::string &  line )

inline

Definition at line 136 of file QwParameterFile.h.

References fStream.

Referenced by ReadUntilNextModule(), and ReadUntilNextSection().

{ fStream << line << std::endl; };

Here is the caller graph for this function:

void QwParameterFile::AppendToSearchPath ( const TString &  searchdir )

static

Add a directory to the search path.

Append a directory to the list of search paths

Parameters

searchdir

Directory to be added

Definition at line 35 of file QwParameterFile.cc.

References fSearchPaths.

Referenced by main().

{
  bfs::path tmppath(searchdir.Data());
  if( bfs::exists(tmppath) && bfs::is_directory(tmppath)) {
    std::cout << tmppath.string()
        << " is a directory; adding it to the search path\n";
    fSearchPaths.push_back(tmppath);
  } else if( bfs::exists(tmppath)) {
    std::cout<<tmppath.string()<<" exists but is not a directory.\n";
  } else {
    std::cout<<tmppath.string()<<" doesn't exist.\n";
  }
}

Here is the caller graph for this function:

void QwParameterFile::Close ( )

inline

Definition at line 205 of file QwParameterFile.h.

References fFile.

{ fFile.close();};

template<typename T >

T QwParameterFile::ConvertValue ( const std::string &  value )

inline

Convert string value into specific type.

Definition at line 241 of file QwParameterFile.h.

References Qw::T.

Referenced by QwDetectorInfo::LoadCrosstalkDefinition(), and QwDetectorInfo::LoadGeometryDefinition().

                                           {
      T retvalue;
      if (value.size() == 0) {
        retvalue = 0; // and pray
      } else {
        std::istringstream stream1;
        stream1.str(value);
        stream1 >> retvalue;
      }
      return retvalue;
    }

Here is the caller graph for this function:

template<>

UInt_t QwParameterFile::ConvertValue ( const std::string &  value )

inline

Definition at line 369 of file QwParameterFile.h.

                                                                          {
  return GetUInt(value);
}

template<>

TString QwParameterFile::ConvertValue ( const std::string &  value )

inline

Definition at line 379 of file QwParameterFile.h.

                                                                            {
  return TString(value.c_str());
}

void QwParameterFile::DisableGreediness ( )

inline

Definition at line 201 of file QwParameterFile.h.

References fBeGreedy.

{fBeGreedy=kFALSE;};

void QwParameterFile::EnableGreediness ( )

inline

Definition at line 200 of file QwParameterFile.h.

References fBeGreedy.

{fBeGreedy=kTRUE;};

Bool_t QwParameterFile::FileHasModuleHeader

(

const std::string &

secname

)

Definition at line 629 of file QwParameterFile.cc.

References LineHasModuleHeader(), ReadNextLine(), and RewindToFileStart().

Referenced by QwRegressionSubsystem::ConstructBranch(), QwMainCerenkovDetector::ConstructBranch(), QwBeamLine::ConstructBranch(), QwIntegratedRaster::ConstructBranch(), and QwLumi::ConstructBranch().

{
  RewindToFileStart();
  while (ReadNextLine()) {
    std::string this_secname;
    if (LineHasModuleHeader(this_secname)) {
      if (this_secname == secname) return kTRUE;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::FileHasModuleHeader

(

const TString &

secname

)

Definition at line 617 of file QwParameterFile.cc.

References LineHasModuleHeader(), ReadNextLine(), and RewindToFileStart().

{
  RewindToFileStart();
  while (ReadNextLine()) {
    std::string this_secname;
    if (LineHasModuleHeader(this_secname)) {
      if (this_secname == secname) return kTRUE;
    }
  }
  return false;
}

Here is the call graph for this function:

Bool_t QwParameterFile::FileHasSectionHeader

(

const std::string &

secname

)

Definition at line 605 of file QwParameterFile.cc.

References LineHasSectionHeader(), ReadNextLine(), and RewindToFileStart().

Referenced by QwSubsystemArray::ConstructBranch().

{
  RewindToFileStart();
  while (ReadNextLine()) {
    std::string this_secname;
    if (LineHasSectionHeader(this_secname)) {
      if (this_secname == secname) return kTRUE;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::FileHasSectionHeader

(

const TString &

secname

)

Definition at line 593 of file QwParameterFile.cc.

References LineHasSectionHeader(), ReadNextLine(), and RewindToFileStart().

{
  RewindToFileStart();
  while (ReadNextLine()) {
    std::string this_secname;
    if (LineHasSectionHeader(this_secname)) {
      if (this_secname == secname) return kTRUE;
    }
  }
  return false;
}

Here is the call graph for this function:

Bool_t QwParameterFile::FileHasVariablePair	(	const std::string &	separatorchars,
		const std::string &	varname,
		std::string &	varvalue
	)

Definition at line 516 of file QwParameterFile.cc.

References HasVariablePair(), ReadNextLine(), and RewindToFileStart().

Referenced by FileHasVariablePair(), QwDetectorInfo::LoadGeometryDefinition(), and QwSubsystemArray::LoadSubsystemsFromParameterFile().

{
  RewindToFileStart();
  while (ReadNextLine()) {
    std::string this_varname;
    if (HasVariablePair(separatorchars, this_varname, varvalue)) {
      if (this_varname == varname) return kTRUE;
    }
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::FileHasVariablePair	(	const std::string &	separatorchars,
		const TString &	varname,
		TString &	varvalue
	)

Definition at line 505 of file QwParameterFile.cc.

References FileHasVariablePair().

{
  std::string tmpval;
  Bool_t status = FileHasVariablePair(separatorchars, varname.Data(), tmpval);
  if (status) varvalue = tmpval.c_str();
  return status;
}

Here is the call graph for this function:

int QwParameterFile::FindFile ( const bfs::path &  directory, const std::string &  file_stem, const std::string &  file_ext, bfs::path &  best_path  )

private

Find the first file in a directory that conforms to the run label.

Find the file in a directory with highest-scoring run label

Parameters

directory	Directory to search in
file_stem	File name stem to search for
file_ext	File name extensions to search for
best_path	(returns) Path to the highest-scoring file

Returns

Score of file

Definition at line 267 of file QwParameterFile.cc.

References QwLog::endl(), fCurrentRunNumber, ParseIntRange(), QwError, and QwWarning.

Referenced by QwParameterFile().

{
  // Return false if the directory does not exist
  if (! bfs::exists(directory)) return false;

  // Default score indicates no match found
  int best_score = -1;
  int score = -1;
  // Multiple overlapping open-ended ranges
  int open_ended_latest_start = 0;
  int open_ended_range_score = 0;

  // Loop over all files in the directory
  // note: default iterator constructor yields past-the-end
  bfs::directory_iterator end_iterator;
  for (bfs::directory_iterator file_iterator(directory);
       file_iterator != end_iterator;
       file_iterator++) {

    // Match the stem and extension
    // note: filename() returns only the file name, not the path
#if BOOST_VERSION >= 104600
    std::string file_name = file_iterator->path().filename().string();
#elif BOOST_VERSION >= 103600
    std::string file_name = file_iterator->filename();
#else
    std::string file_name = file_iterator->leaf();
#endif
    // stem
    size_t pos_stem = file_name.find(file_stem);
    if (pos_stem != 0) continue;
    // extension (reverse find)
    size_t pos_ext = file_name.rfind(file_ext);
    if (pos_ext != file_name.length() - file_ext.length()) continue;

    // Scores (from low to high)
    const int score_no_run_label = 1;
    // Open run range:
    // score increments each time a higher-starting range is found
    // difference between min and max gives maximum number of open ranges
    const int score_open_ended_run_range_min = 1000;
    const int score_open_ended_run_range_max = 9000;
    // Close run range:
    // score decremented from max by size of run range, small range -> high score
    // difference between min and max gives maximum number of runs in closed range
    const int score_closed_run_range_min = 10000;
    const int score_closed_run_range_max = 90000;
    // Single run label will always have maximum score
    const int score_single_run_label = INT_MAX;

    // Determine run label length
    size_t label_length = pos_ext - file_stem.length();
    // no run label
    if (label_length == 0) {
      score = score_no_run_label;
    } else {
      // run label starts after dot ('.') and that dot is included in the label length
      if (file_name.at(pos_stem + file_stem.length()) == '.') {
        std::string label = file_name.substr(pos_stem + file_stem.length() + 1, label_length - 1);
        std::pair<int,int> range = ParseIntRange("-",label);
        int run = fCurrentRunNumber;
        if ((range.first <= run) && (run <= range.second)) {

          // run is in single-value range
          if (range.first == range.second) {
            score = score_single_run_label;

          // run is in double-value range
          } else if (range.second < INT_MAX) {
            int number_of_runs = abs(range.second - range.first);
            score = score_closed_run_range_max - number_of_runs;
            if (score < score_closed_run_range_min) {
              score = score_closed_run_range_min;
              QwError << "Too many runs in closed run range for " << file_stem << QwLog::endl;
              QwWarning << "Range is from " << range.first << " to " << range.second << QwLog::endl;
            }

          // run is in open-ended range
          } else if (range.second == INT_MAX) {
            // each matching open-ended range
            if (range.first > open_ended_latest_start) {
              open_ended_latest_start = range.first;
              open_ended_range_score++;
              score = score_open_ended_run_range_min + open_ended_range_score;
              if (score > score_open_ended_run_range_max) {
                score = score_open_ended_run_range_max;
                QwError << "Too many open ended run ranges for " << file_stem << QwLog::endl;
              }

            } else score = score_open_ended_run_range_min;
          }
        } else
          // run not in range
          score = -1;
      } else
  // run label does not start with a dot (i.e. partial match of stem)
  score = -1;
    }

    // Look for the match with highest score
    if (score > best_score) {
      best_path = *file_iterator;
      best_score = score;
    }
  }
  return best_score;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::GetKeyValue ( const std::string  keyname, std::string &  retvalue, Bool_t  should_erase = kFALSE  )

inlineprotected

Current position in the line.

Definition at line 308 of file QwParameterFile.h.

References fKeyValuePair.

Referenced by PopValue(), and ReturnValue().

                                        {
      Bool_t status = kFALSE;
      std::map<std::string,std::string>::iterator it;
      it = fKeyValuePair.find(keyname);
      if (it != fKeyValuePair.end()) {
  status = kTRUE;
  retvalue = (*it).second;
  if (should_erase){
    fKeyValuePair.erase(it);
  }
      }
      return status;
    }

Here is the caller graph for this function:

std::string QwParameterFile::GetLine ( )

inline

Definition at line 135 of file QwParameterFile.h.

References fLine.

Referenced by QwEventBuffer::GetNextRunRange(), HasValue(), QwHistogramHelper::LoadTreeParamsFromFile(), QwEventBuffer::ProcessOptions(), ReadUntilNextModule(), and ReadUntilNextSection().

{ return fLine; };

Here is the caller graph for this function:

std::string QwParameterFile::GetNextToken

(

const std::string &

separatorchars

)

Get next token as a string.

Definition at line 762 of file QwParameterFile.cc.

References fCurrentPos, fLine, and TrimWhitespace().

Referenced by QwRegression::LoadChannelMap(), and QwMainCerenkovDetector::LoadChannelMap().

{
  std::string tmpstring = "";
  if (fCurrentPos != std::string::npos){
    size_t pos1 = fCurrentPos;
    size_t pos2 = fLine.find_first_of(separatorchars.c_str(), pos1);
    if (pos2 == std::string::npos){
      fCurrentPos = pos2;
      tmpstring   = fLine.substr(pos1);
    } else {
      fCurrentPos = fLine.find_first_not_of(separatorchars.c_str(), pos2);
      tmpstring   = fLine.substr(pos1,pos2-pos1);
    }
  }
  TrimWhitespace(tmpstring,TString::kBoth);
  return tmpstring;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string QwParameterFile::GetNextToken ( )

inline

Definition at line 127 of file QwParameterFile.h.

References fTokenSepChars, and GetNextToken().

Referenced by GetNextToken(), and GetTypedNextToken().

{ return GetNextToken(fTokenSepChars); };

Here is the call graph for this function:

Here is the caller graph for this function:

TString QwParameterFile::GetParameterFileContents

(

)

Definition at line 861 of file QwParameterFile.cc.

References fBestParamFileNameAndPath, and Qw::ms.

Referenced by GetParamFileNameContents().

{
  TMacro *fParameterFile = new TMacro(fBestParamFileNameAndPath);
  TString ms;
  TList *list = fParameterFile->GetListOfLines();
  for(Int_t i=0; i < list->GetSize(); i++) {
    ms += list->At(i)->GetName();
    ms += "\n";
  }
  delete fParameterFile;
  fParameterFile = NULL;
  return ms;
}

Here is the caller graph for this function:

const TString QwParameterFile::GetParamFilename ( )

inline

Definition at line 191 of file QwParameterFile.h.

References fBestParamFileName.

Referenced by GetParamFileNameContents().

{return fBestParamFileName;};

Here is the caller graph for this function:

const TString QwParameterFile::GetParamFilenameAndPath ( )

inline

Definition at line 192 of file QwParameterFile.h.

References fBestParamFileNameAndPath.

{return fBestParamFileNameAndPath;};

const std::pair<TString, TString> QwParameterFile::GetParamFileNameContents ( )

inline

Definition at line 194 of file QwParameterFile.h.

References GetParameterFileContents(), and GetParamFilename().

Referenced by VQwSubsystemTracking::LoadCrosstalkDefinition(), and VQwSubsystemTracking::LoadGeometryDefinition().

                                                               {
      return std::pair<TString, TString>(GetParamFilename(), GetParameterFileContents());
    };

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

T QwParameterFile::GetTypedNextToken ( )

inline

Get next token into specific type.

Definition at line 131 of file QwParameterFile.h.

References GetNextToken().

Referenced by QwBeamLine::AssignGeometry(), QwHistogramHelper::GetHistParamsFromLine(), QwBeamLine::LoadChannelMap(), and QwBeamDetectorID::QwBeamDetectorID().

                          {
      return ConvertValue<T>(GetNextToken());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

UInt_t QwParameterFile::GetUInt ( const TString &  varvalue )

static

Convert a string number value to an unsigned integer

Parameters

varvalue

String with decimal or hexadecimal number

Returns

Unsigned integer

Definition at line 54 of file QwParameterFile.cc.

Referenced by QwDriftChamberHDC::LoadChannelMap(), QwDriftChamberVDC::LoadChannelMap(), QwSciFiDetector::LoadChannelMap(), QwScaler::LoadChannelMap(), QwTriggerScintillator::LoadChannelMap(), QwRaster::LoadChannelMap(), QwMainDetector::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwComptonPhotonDetector::LoadChannelMap(), QwMainCerenkovDetector::LoadChannelMap(), QwIntegratedRaster::LoadChannelMap(), QwMollerDetector::LoadChannelMap(), QwLumi::LoadChannelMap(), QwComptonElectronDetector::LoadChannelMap(), QwScanner::LoadChannelMap(), VQwSubsystem::LoadDetectorMaps(), QwBeamLine::LoadEventCuts(), QwMainCerenkovDetector::LoadEventCuts(), QwIntegratedRaster::LoadEventCuts(), QwBeamMod::LoadEventCuts(), QwLumi::LoadEventCuts(), and QwHelicity::ProcessOptions().

{
  UInt_t value = 0;
  if (varvalue.IsDigit()){
    value = varvalue.Atoi();
  } else if (varvalue.BeginsWith("0x") || varvalue.BeginsWith("0X")
       || varvalue.BeginsWith("x") || varvalue.BeginsWith("X")
       || varvalue.IsHex()){
    //any whitespace ?
    Int_t end = varvalue.Index(" ");
    std::istringstream stream1;
    if (end == -1){
      stream1.str(varvalue.Data());
    } else {
      //make temporary string, removing whitespace
      Int_t start = 0;
      TString tmp;
      //loop over all whitespace
      while (end > -1) {
        tmp += varvalue(start, end-start);
        start = end+1;
        end = varvalue.Index(" ", start);
      }
      //finally add part from last whitespace to end of string
      end = varvalue.Length();
      tmp += varvalue(start, end-start);
      stream1.str(tmp.Data());
    }
    stream1 >> std::hex >> value;
  }
  return value;
}

Here is the caller graph for this function:

Bool_t QwParameterFile::HasNewPairs ( )

inline

Definition at line 207 of file QwParameterFile.h.

References fHasNewPairs.

                        {
      Bool_t status = fHasNewPairs;
      if (fHasNewPairs) fHasNewPairs=kFALSE;
      return status;
    };

Bool_t QwParameterFile::HasValue

(

TString &

vname

)

Definition at line 447 of file QwParameterFile.cc.

References QwLog::endl(), GetLine(), QwMessage, ReadNextLine(), RewindToFileStart(), and TrimWhitespace().

Referenced by QwEnergyCalculator::ConstructBranch(), QwHaloMonitor::ConstructBranch(), QwIntegratedRasterChannel< T >::ConstructBranch(), QwClock< T >::ConstructBranch(), QwCombinedPMT::ConstructBranch(), QwQPD::ConstructBranch(), QwBPMCavity::ConstructBranch(), QwLinearDiodeArray::ConstructBranch(), QwCombinedBPM< T >::ConstructBranch(), QwBPMStripline< T >::ConstructBranch(), VQwHardwareChannel::ConstructBranch(), QwIntegrationPMT::ConstructBranch(), and QwBCM< T >::ConstructBranch().

{
  Bool_t status=kFALSE;
  TString vline;

  RewindToFileStart();
  while (ReadNextLine()){
    TrimWhitespace();
    vline=(GetLine()).c_str();

    vline.ToLower();
    TRegexp regexp(vline);
    vname.ToLower();
    if (vname.Contains(regexp)){
      QwMessage <<" QwParameterFile::HasValue  "<<vline<<" "<<vname<<QwLog::endl;
      status=kTRUE;
      break;
    }
  }

  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::HasVariablePair	(	const std::string &	separatorchars,
		std::string &	varname,
		std::string &	varvalue
	)

Definition at line 485 of file QwParameterFile.cc.

References fLine, and TrimWhitespace().

Referenced by QwEPICSEvent::ExtractEPICSValues(), FileHasVariablePair(), HasVariablePair(), QwDetectorInfo::LoadCrosstalkDefinition(), VQwSubsystem::LoadDetectorMaps(), ReadNextLine_Greedy(), and ReadNextLine_Single().

{
  Bool_t status = kFALSE;
  size_t equiv_pos1 = fLine.find_first_of(separatorchars);
  if (equiv_pos1 != std::string::npos){
    size_t equiv_pos2 = fLine.find_first_not_of(separatorchars,equiv_pos1);
    if (equiv_pos2 != std::string::npos){
      varname  = fLine.substr(0,equiv_pos1);
      varvalue = fLine.substr(equiv_pos2);
      TrimWhitespace(varname,  TString::kBoth);
      TrimWhitespace(varvalue, TString::kBoth);
      status = kTRUE;
    }
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::HasVariablePair	(	const std::string &	separatorchars,
		TString &	varname,
		TString &	varvalue
	)

Definition at line 471 of file QwParameterFile.cc.

References HasVariablePair().

{
  std::string tmpvar, tmpval;
  Bool_t status = HasVariablePair(separatorchars, tmpvar, tmpval);
  if (status){
    varname  = tmpvar.c_str();
    varvalue = tmpval.c_str();
  }
  return status;
}

Here is the call graph for this function:

Bool_t QwParameterFile::IsEOF ( )

inline

Definition at line 123 of file QwParameterFile.h.

References fStream.

Referenced by QwEventBuffer::GetNextEventRange(), QwEventBuffer::GetNextRunRange(), ReadNextModule(), and ReadNextSection().

{ return fStream.eof();};

Here is the caller graph for this function:

TString QwParameterFile::LastString	(	TString	in,
		char *	delim
	)

Definition at line 853 of file QwParameterFile.cc.

Referenced by SetParamFilename().

{ 
  TObjArray*  all_strings = in.Tokenize(delim); 
  TObjString* last_string = (TObjString*) all_strings->Last();
  return last_string->GetString();
};

Here is the caller graph for this function:

Bool_t QwParameterFile::LineHasModuleHeader

(

)

Definition at line 562 of file QwParameterFile.cc.

Referenced by FileHasModuleHeader(), LineHasModuleHeader(), ReadNextModule(), and ReadUntilNextModule().

{
  std::string secname;
  return LineHasModuleHeader(secname);
}

Here is the caller graph for this function:

Bool_t QwParameterFile::LineHasModuleHeader

(

std::string &

secname

)

Definition at line 576 of file QwParameterFile.cc.

References fLine, fModuleChars, TrimComment(), and TrimWhitespace().

{
  TrimComment();
  Bool_t status = kFALSE;
  size_t equiv_pos1 = fLine.find_first_of(fModuleChars[0]);
  if (equiv_pos1 != std::string::npos) {
    size_t equiv_pos2 = fLine.find_first_of(fModuleChars[1],equiv_pos1);
    if (equiv_pos2 != std::string::npos && equiv_pos2 - equiv_pos1 > 1) {
      secname = fLine.substr(equiv_pos1 + 1, equiv_pos2 - equiv_pos1 - 1);
      TrimWhitespace(secname, TString::kBoth);
      status = kTRUE;
    }
  }
  return status;
}

Here is the call graph for this function:

Bool_t QwParameterFile::LineHasModuleHeader

(

TString &

secname

)

Definition at line 568 of file QwParameterFile.cc.

References LineHasModuleHeader().

{
  std::string secname_tmp = secname.Data();
  Bool_t status = LineHasModuleHeader(secname_tmp);
  secname = secname_tmp;
  return status;
}

Here is the call graph for this function:

Bool_t QwParameterFile::LineHasSectionHeader

(

)

Definition at line 532 of file QwParameterFile.cc.

Referenced by FileHasSectionHeader(), LineHasSectionHeader(), QwRegression::LoadChannelMap(), ReadNextSection(), ReadUntilNextSection(), and SkipSection().

{
  std::string secname;
  return LineHasSectionHeader(secname);
}

Here is the caller graph for this function:

Bool_t QwParameterFile::LineHasSectionHeader

(

std::string &

secname

)

Definition at line 546 of file QwParameterFile.cc.

References fLine, TrimComment(), and TrimWhitespace().

{
  TrimComment();
  Bool_t status = kFALSE;
  size_t equiv_pos1 = fLine.find_first_of('[');
  if (equiv_pos1 != std::string::npos) {
    size_t equiv_pos2 = fLine.find_first_of(']',equiv_pos1);
    if (equiv_pos2 != std::string::npos && equiv_pos2 - equiv_pos1 > 1) {
      secname = fLine.substr(equiv_pos1 + 1, equiv_pos2 - equiv_pos1 - 1);
      TrimWhitespace(secname, TString::kBoth);
      status = kTRUE;
    }
  }
  return status;
}

Here is the call graph for this function:

Bool_t QwParameterFile::LineHasSectionHeader

(

TString &

secname

)

Definition at line 538 of file QwParameterFile.cc.

References LineHasSectionHeader().

{
  std::string secname_tmp = secname.Data();
  Bool_t status = LineHasSectionHeader(secname_tmp);
  secname = secname_tmp;
  return status;
}

Here is the call graph for this function:

Bool_t QwParameterFile::LineIsEmpty ( )

inline

Definition at line 122 of file QwParameterFile.h.

References fLine.

Referenced by QwEventBuffer::GetNextEventRange(), QwRegression::LoadChannelMap(), QwHistogramHelper::LoadHistParamsFromFile(), QwHistogramHelper::LoadTreeParamsFromFile(), and ReadNextLine_Greedy().

{return fLine.empty();};

Here is the caller graph for this function:

bool QwParameterFile::OpenFile ( const bfs::path &  file )

private

Open a file.

Open a file at the specified location

Parameters

file	Path to file to be opened

Returns

False if the file could not be opened

Definition at line 205 of file QwParameterFile.cc.

References QwLog::endl(), fBestParamFileNameAndPath, fFile, fStream, QwError, and SetParamFilename().

Referenced by QwParameterFile().

{
  Bool_t local_debug = false;

  Bool_t status = false;

  Bool_t check_whether_path_exists_and_is_a_regular_file = false;
  
  // Check whether path exists and is a regular file
#if BOOST_VERSION >= 103600
  check_whether_path_exists_and_is_a_regular_file = bfs::exists(file) && bfs::is_regular_file(file);
#elif BOOST_VERSION >= 103400
  check_whether_path_exists_and_is_a_regular_file = bfs::exists(file) && bfs::is_regular(file);
#else
  check_whether_path_exists_and_is_a_regular_file = bfs::exists(file); /* pray */
#endif

  if (check_whether_path_exists_and_is_a_regular_file) {
    
    fBestParamFileNameAndPath = file.string();
    this->SetParamFilename();
    
    // Connect stream (fFile) to file
    fFile.open(file.string().c_str());
    if (! fFile.good())
      QwError << "QwParameterFile::OpenFile Unable to read parameter file "
        << file.string() << QwLog::endl;
    // Load into stream
    fStream << fFile.rdbuf();
    status = true;
    if(local_debug) {
      std::cout << "------before close------------" << std::endl;
      std::cout << fStream.str() << std::endl;
    }

    // fFile.clear();
    // fFile.close(); // disconnet file
    //    this->Test();
  } else {

    // File does not exist or is not a regular file
    QwError << "QwParameterFile::OpenFile Unable to open parameter file "
      << file.string() << QwLog::endl;
    status = false;
  }
  if(local_debug) {
    std::cout << "-------after close ----------" << std::endl;
    std::cout << fStream.str() << std::endl;
  }
  
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::pair< int, int > QwParameterFile::ParseIntRange ( const std::string &  separatorchars, const std::string &  range  )

static

Parse a range of integers as #:# where either can be missing.

Separate a separated range of integers into a pair of values.

Parameters

separatorchars	String with possible separator characters to consider.
range	String containing two integers separated by a separator character, or a single value. If the string begins with the separator character, the first value is taken as zero. If the string ends with the separator character, the second value is taken as kMaxInt.

Returns

Pair of integers of the first and last values of the range. If the range contains a single value, the two integers will be identical.

Definition at line 802 of file QwParameterFile.cc.

References QwLog::endl(), QwError, and QwVerbose.

Referenced by FindFile(), QwOptions::GetIntValuePair(), QwEventBuffer::GetNextEventRange(), and QwEventBuffer::GetNextRunRange().

{
  std::pair<int,int> mypair;
  size_t pos = range.find_first_of(separatorchars);
  if (pos == std::string::npos) {
    //  Separator not found.
    mypair.first  = atoi(range.substr(0,range.length()).c_str());
    mypair.second = mypair.first;
  } else {
    size_t end = range.length() - pos - 1;
    if (pos == 0) {
      // Separator is the first character
      mypair.first  = 0;
      mypair.second = atoi(range.substr(pos+1, end).c_str());
    } else if (pos == range.length() - 1) {
      // Separator is the last character
      mypair.first  = atoi(range.substr(0,pos).c_str());
      mypair.second = INT_MAX;
    } else {
      mypair.first  = atoi(range.substr(0,pos).c_str());
      mypair.second = atoi(range.substr(pos+1, end).c_str());
    }
  }

  //  Check the values for common errors.
  if (mypair.first < 0){
    QwError << "The first value must not be negative!" << QwLog::endl;
    return std::pair<int,int>(INT_MAX,INT_MAX);
  } else if (mypair.first > mypair.second){
    QwError << "The first value must not be larger than the second value"
      << QwLog::endl;
    return std::pair<int,int>(INT_MAX,INT_MAX);
  }

  //  Print the contents of the pair for debugging.
  QwVerbose << "The range goes from " << mypair.first
      << " to " << mypair.second << QwLog::endl;

  return mypair;
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

Bool_t QwParameterFile::PopValue ( const std::string  keyname, T &  retvalue  )

inline

Definition at line 223 of file QwParameterFile.h.

References GetKeyValue().

                                                           {
      std::string value;
      Bool_t status = GetKeyValue(keyname, value, kTRUE);
      if (status){
  retvalue = ConvertValue<T>(value);
      }
      return status;
    };

Here is the call graph for this function:

std::streambuf* QwParameterFile::rdbuf ( ) const

inline

Access the streambuf pointer in the same way as on a std::ifstream.

Definition at line 56 of file QwParameterFile.h.

References fStream.

Referenced by QwOptions::ParseConfigFile().

{return fStream.rdbuf(); };

Here is the caller graph for this function:

QwParameterFile * QwParameterFile::ReadModulePreamble

(

)

Rewinds to the start and read until it finds next module header.

Read the lines until the first header

Returns

Pointer to the parameter stream until first module

Definition at line 736 of file QwParameterFile.cc.

References ReadUntilNextModule(), and RewindToFileStart().

{
  RewindToFileStart();
  return ReadUntilNextModule();
}

Here is the call graph for this function:

Bool_t QwParameterFile::ReadNextLine ( )

inline

Definition at line 71 of file QwParameterFile.h.

References fCurrentPos.

Referenced by QwEPICSEvent::ExtractEPICSValues(), FileHasModuleHeader(), FileHasSectionHeader(), FileHasVariablePair(), QwEventBuffer::GetNextEventRange(), HasValue(), QwRegression::LoadChannelMap(), QwBeamLine::LoadChannelMap(), QwMainCerenkovDetector::LoadChannelMap(), QwDetectorInfo::LoadCrosstalkDefinition(), VQwSubsystem::LoadDetectorMaps(), QwHistogramHelper::LoadHistParamsFromFile(), QwHistogramHelper::LoadTreeParamsFromFile(), ReadNextLine_Single(), ReadNextModule(), ReadNextSection(), ReadUntilNextModule(), ReadUntilNextSection(), and SkipSection().

                          {
      fCurrentPos = 0;
      std::string tmp;
      return ReadNextLine(tmp);
    };

Here is the caller graph for this function:

Bool_t QwParameterFile::ReadNextLine ( std::string &  varvalue )

inline

Definition at line 76 of file QwParameterFile.h.

References fBeGreedy, ReadNextLine_Greedy(), and ReadNextLine_Single().

                                             {
      Bool_t status = kFALSE;
      if (fBeGreedy) status = ReadNextLine_Greedy(varvalue);
      else           status = ReadNextLine_Single(varvalue);
      return status;
    }

Here is the call graph for this function:

Bool_t QwParameterFile::ReadNextLine_Greedy

(

std::string &

varvalue

)

Definition at line 882 of file QwParameterFile.cc.

References fBreakpointWords, fHasNewPairs, fKeyValuePair, HasVariablePair(), LineIsEmpty(), ReadNextLine_Single(), RewindToLineStart(), TrimComment(), and TrimWhitespace().

Referenced by ReadNextLine().

{
  //  Keep reading until a non-comment, non-empty,
  //  non-keyword-value-pair line has been found.
  Bool_t status;
  std::string tmpname, tmpvalue;
  while ((status = ReadNextLine_Single(varvalue))){
    TrimComment();
    TrimWhitespace();
    if (LineIsEmpty()) continue;
    if (HasVariablePair("=",tmpname,tmpvalue)){
      std::transform(tmpname.begin(), tmpname.end(),
         tmpname.begin(), ::tolower);
      if (fBreakpointWords.count(tmpname)==1){
  RewindToLineStart();
  break;
      } else {
  fKeyValuePair[tmpname] = tmpvalue;
  fHasNewPairs = kTRUE;
  continue;
      }
    }
    break;
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwParameterFile::ReadNextLine_Single ( std::string &  varvalue )

inline

Definition at line 83 of file QwParameterFile.h.

References fCurrentPos, fLine, fStream, HasVariablePair(), and ReadNextLine().

Referenced by ReadNextLine(), and ReadNextLine_Greedy().

                                                    {
      fCurrentPos = 0;
      if (! getline(fStream, fLine))
        // No next line
        return 0;
      else {
        // Copy next line
        varvalue = fLine;
        // Allow 'append'
        std::string tmpname, tmpvalue;
        if (HasVariablePair(" ",tmpname,tmpvalue)) {
          if (tmpname == "append") {
            // Test for recursion in file nesting
            static int nested_depth = 0;
            if (nested_depth++ > 5) {
              std::cout << "Parameter file recursion not allowed!" << std::endl;
              return 0;
            }
            // Stream nested file into this file
            QwParameterFile nested_file(tmpvalue.c_str());
            fStream << nested_file.rdbuf();
            // Read line from appended file
            return ReadNextLine(varvalue);
          }
        }
        return 1;
      }
    };

Here is the call graph for this function:

Here is the caller graph for this function:

QwParameterFile * QwParameterFile::ReadNextModule	(	std::string &	secname,
		bool	keep_header = false
	)

Read the lines of the next module

Parameters

secname	Name of the next module (returns)
keep_header	Flag to keep header of module

Returns

Pointer to the parameter stream of the next module

Definition at line 748 of file QwParameterFile.cc.

References IsEOF(), LineHasModuleHeader(), ReadNextLine(), and ReadUntilNextModule().

Referenced by VQwSubsystemTracking::LoadGeometryDefinition(), QwHistogramHelper::LoadTreeParamsFromFile(), and ReadNextModule().

{
  if (IsEOF()) return 0;
  while (! LineHasModuleHeader(secname) && ReadNextLine()); // skip until header
  return ReadUntilNextModule(keep_header);
}

Here is the call graph for this function:

Here is the caller graph for this function:

QwParameterFile * QwParameterFile::ReadNextModule	(	TString &	secname,
		bool	keep_header = false
	)

Definition at line 755 of file QwParameterFile.cc.

References IsEOF(), LineHasModuleHeader(), ReadNextLine(), and ReadUntilNextModule().

{
  if (IsEOF()) return 0;
  while (! LineHasModuleHeader(secname) && ReadNextLine()); // skip until header
  return ReadUntilNextModule(keep_header);
}

Here is the call graph for this function:

QwParameterFile* QwParameterFile::ReadNextModule ( const bool  keep_header = false )

inline

Definition at line 183 of file QwParameterFile.h.

References ReadNextModule().

                                                                    {
      std::string dummy;
      return ReadNextModule(dummy, keep_header);
    };

Here is the call graph for this function:

QwParameterFile * QwParameterFile::ReadNextSection	(	std::string &	secname,
		const bool	keep_header = false
	)

Read the lines of the next section

Parameters

secname	Name of the next section (returns)
keep_header	Keep the header inside the section

Returns

Pointer to the parameter stream of the next section

Definition at line 717 of file QwParameterFile.cc.

References IsEOF(), LineHasSectionHeader(), ReadNextLine(), and ReadUntilNextSection().

Referenced by QwEventBuffer::GetNextRunRange(), QwRegression::LoadChannelMap(), QwBeamLine::LoadChannelMap(), QwMainCerenkovDetector::LoadChannelMap(), QwBeamMod::LoadChannelMap(), VQwSubsystemTracking::LoadCrosstalkDefinition(), VQwSubsystemTracking::LoadGeometryDefinition(), QwSubsystemArray::LoadSubsystemsFromParameterFile(), QwHistogramHelper::LoadTreeParamsFromFile(), and ReadNextSection().

{
  if (IsEOF()) return 0;
  while (! LineHasSectionHeader(secname) && ReadNextLine()); // skip until header
  return ReadUntilNextSection(keep_header);
}

Here is the call graph for this function:

Here is the caller graph for this function:

QwParameterFile * QwParameterFile::ReadNextSection	(	TString &	secname,
		const bool	keep_header = false
	)

Definition at line 724 of file QwParameterFile.cc.

References IsEOF(), LineHasSectionHeader(), ReadNextLine(), and ReadUntilNextSection().

{
  if (IsEOF()) return 0;
  while (! LineHasSectionHeader(secname) && ReadNextLine()); // skip until header
  return ReadUntilNextSection(keep_header);
}

Here is the call graph for this function:

QwParameterFile* QwParameterFile::ReadNextSection ( const bool  keep_header = false )

inline

Definition at line 173 of file QwParameterFile.h.

References ReadNextSection().

                                                                     {
      std::string dummy;
      return ReadNextSection(dummy, keep_header);
    };

Here is the call graph for this function:

QwParameterFile * QwParameterFile::ReadSectionPreamble

(

)

Rewinds to the start and read until it finds next section header.

Read the lines until the first header

Returns

Pointer to the parameter stream until first section

Definition at line 705 of file QwParameterFile.cc.

References ReadUntilNextSection(), and RewindToFileStart().

Referenced by QwSubsystemArray::ConstructBranch(), VQwSubsystemTracking::LoadCrosstalkDefinition(), VQwSubsystemTracking::LoadGeometryDefinition(), and QwSubsystemArray::LoadSubsystemsFromParameterFile().

{
  RewindToFileStart();
  return ReadUntilNextSection();
}

Here is the call graph for this function:

Here is the caller graph for this function:

QwParameterFile * QwParameterFile::ReadUntilNextModule

(

const bool

add_current_line = false

)

Read from current position until next module header

Returns

Pointer to the parameter stream until next module

Definition at line 660 of file QwParameterFile.cc.

References AddLine(), GetLine(), LineHasModuleHeader(), QwParameterFile(), and ReadNextLine().

Referenced by QwRegressionSubsystem::ConstructBranch(), QwMainCerenkovDetector::ConstructBranch(), QwBeamLine::ConstructBranch(), QwIntegratedRaster::ConstructBranch(), QwLumi::ConstructBranch(), ReadModulePreamble(), and ReadNextModule().

{
  std::string nextheader; // dummy
  QwParameterFile* section = new QwParameterFile();
  if (add_current_line) section->AddLine(GetLine()); // add current line
  while (ReadNextLine() && ! LineHasModuleHeader(nextheader)) {
    section->AddLine(GetLine());
  }
  return section;
}

Here is the call graph for this function:

Here is the caller graph for this function:

QwParameterFile * QwParameterFile::ReadUntilNextSection

(

const bool

add_current_line = false

)

Read from current position until next section header

Returns

Pointer to the parameter stream until next section

Definition at line 645 of file QwParameterFile.cc.

References AddLine(), GetLine(), LineHasSectionHeader(), QwParameterFile(), and ReadNextLine().

Referenced by QwSubsystemArray::ConstructBranch(), ReadNextSection(), and ReadSectionPreamble().

{
  std::string nextheader; // dummy
  QwParameterFile* section = new QwParameterFile();
  if (add_current_line) section->AddLine(GetLine()); // add current line
  while (ReadNextLine() && ! LineHasSectionHeader(nextheader)) {
    section->AddLine(GetLine());
  }
  return section;
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename T >

Bool_t QwParameterFile::ReturnValue ( const std::string  keyname, T &  retvalue  )

inline

Definition at line 214 of file QwParameterFile.h.

References GetKeyValue().

Referenced by VQwScaler_Channel::LoadChannelParameters(), and QwVQWK_Channel::LoadChannelParameters().

                                                              {
      std::string value;
      Bool_t status = GetKeyValue(keyname, value);
      if (status){
  retvalue = ConvertValue<T>(value);
      }
      return status;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwParameterFile::RewindToFileStart ( )

inline

Definition at line 138 of file QwParameterFile.h.

References fStream.

Referenced by QwRegressionSubsystem::ConstructBranch(), QwMainCerenkovDetector::ConstructBranch(), QwBeamLine::ConstructBranch(), QwIntegratedRaster::ConstructBranch(), QwLumi::ConstructBranch(), FileHasModuleHeader(), FileHasSectionHeader(), FileHasVariablePair(), HasValue(), QwDetectorInfo::LoadCrosstalkDefinition(), VQwSubsystem::LoadDetectorMaps(), VQwSubsystemTracking::LoadGeometryDefinition(), ReadModulePreamble(), and ReadSectionPreamble().

{ fStream.clear(); fStream.seekg(0, std::ios::beg); };

Here is the caller graph for this function:

void QwParameterFile::RewindToLineStart ( )

inline

Definition at line 139 of file QwParameterFile.h.

References fCurrentPos.

Referenced by ReadNextLine_Greedy().

{ fCurrentPos = 0; };

Here is the caller graph for this function:

void QwParameterFile::SetCommentChars ( const std::string  value )

inline

Set various sets of special characters.

Definition at line 65 of file QwParameterFile.h.

References fCommentChars.

{ fCommentChars = value; };

static void QwParameterFile::SetCurrentRunNumber ( const UInt_t  runnumber )

inlinestatic

Set the current run number for looking up the appropriate parameter file.

Definition at line 62 of file QwParameterFile.h.

References fCurrentRunNumber.

Referenced by main().

{ fCurrentRunNumber = runnumber; };

Here is the caller graph for this function:

void QwParameterFile::SetEOF ( )

inlineprivate

Definition at line 358 of file QwParameterFile.h.

References fStream.

Referenced by QwParameterFile().

{ fStream.setstate(std::ios::eofbit); };

Here is the caller graph for this function:

void QwParameterFile::SetModuleChars ( const std::string  value )

inline

Definition at line 69 of file QwParameterFile.h.

References fModuleChars.

{ fModuleChars = value; };

void QwParameterFile::SetParamFilename

(

)

Definition at line 845 of file QwParameterFile.cc.

References fBestParamFileName, fBestParamFileNameAndPath, and LastString().

Referenced by OpenFile().

{
  Char_t delimiters[] = "/";
  fBestParamFileName = LastString(fBestParamFileNameAndPath, delimiters);  
  return;
};

Here is the call graph for this function:

Here is the caller graph for this function:

void QwParameterFile::SetSectionChars ( const std::string  value )

inline

Definition at line 68 of file QwParameterFile.h.

References fSectionChars.

{ fSectionChars = value; };

void QwParameterFile::SetTokenSepChars ( const std::string  value )

inline

Definition at line 67 of file QwParameterFile.h.

References fTokenSepChars.

{ fTokenSepChars = value; };

void QwParameterFile::SetWhitespaceChars ( const std::string  value )

inline

Definition at line 66 of file QwParameterFile.h.

References fWhitespaceChars.

{ fWhitespaceChars = value; };

Bool_t QwParameterFile::SkipSection

(

std::string

secname

)

Skips from the beginning of the section 'secname' until the first section that does not have that name.

Definition at line 671 of file QwParameterFile.cc.

References QwLog::endl(), LineHasSectionHeader(), QwDebug, and ReadNextLine().

{
  //  If the current line begins the section to be skipped,
  //  just keep reading until we get to the next section.
  //  Recurse, just in case the next section is the same
  //  section name.
  Bool_t status = kTRUE;
  std::string tmpname;
  if (LineHasSectionHeader(tmpname)){
    if (tmpname == secname){
      QwDebug << "QwParameterFile::SkipSection:  "
        << "Begin skipping section " << tmpname << QwLog::endl;
      while ((status=ReadNextLine()) && ! LineHasSectionHeader(tmpname)) {
  //  Do nothing for each line.
      }
      QwDebug << "QwParameterFile::SkipSection:  "
        << "Reached the end of the section." 
        << QwLog::endl;
      if (status){
  // Recurse, in case the next section has the same
  // section name, but only if we found a new section
  // header.
  status = SkipSection(secname);
      }
    }
  }
  return status;
}

Here is the call graph for this function:

void QwParameterFile::Trim ( const std::string &  chars, std::string &  token, TString::EStripType  head_tail = TString::kBoth  )

protected

Definition at line 388 of file QwParameterFile.cc.

Referenced by TrimModuleHeader(), TrimSectionHeader(), and TrimWhitespace().

{
  //  If the first bit is set, this routine removes leading chars from the
  //  line.  If the second bit is set, this routine removes trailing chars
  //  from the line.  The default behavior is to remove both.
  size_t mypos;
  //  Remove leading chars.  If this first test returns "npos", it means
  //  this line is all chars, so get rid of it all.
  //  If we're not removing leading chars, lines which are all chars
  //  will not be removed.
  mypos = token.find_first_not_of(chars);
  if (head_tail & TString::kLeading) token.erase(0,mypos);
  //  Remove trailing spaces
  mypos = token.find_last_not_of(chars);
  mypos = token.find_first_of(chars,mypos);
  if (mypos != std::string::npos && (head_tail & TString::kTrailing)){
    token.erase(mypos);
  }
}

Here is the caller graph for this function:

void QwParameterFile::TrimComment

(

const char

commentchar

)

Definition at line 418 of file QwParameterFile.cc.

References TrimComment().

Referenced by QwHistogramHelper::GetHistParamsFromFile(), QwEventBuffer::GetNextEventRange(), QwMagneticField::LoadBeamProperty(), QwEvent::LoadBeamProperty(), QwEPICSEvent::LoadChannelMap(), QwRegression::LoadChannelMap(), QwBeamLine::LoadChannelMap(), QwMainCerenkovDetector::LoadChannelMap(), QwComptonElectronDetector::LoadChannelMap(), VQwSubsystemTracking::LoadCrosstalkDefinition(), VQwSubsystem::LoadDetectorMaps(), VQwSubsystemTracking::LoadGeometryDefinition(), QwHistogramHelper::LoadHistParamsFromFile(), QwBeamMod::LoadInputParameters(), QwComptonElectronDetector::LoadInputParameters(), and QwHistogramHelper::LoadTreeParamsFromFile().

{
  std::string commentchars = ""; // no std::string c'tor from single char
  commentchars += commentchar; // so we have to use the operator+= overload
  TrimComment(commentchars);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwParameterFile::TrimComment

(

const std::string &

commentchars

)

Definition at line 425 of file QwParameterFile.cc.

References fLine.

{
  // Remove everything after the comment character
  size_t mypos = fLine.find_first_of(commentchars);
  if (mypos != std::string::npos){
    fLine.erase(mypos);
  }
}

void QwParameterFile::TrimComment ( )

inline

Definition at line 115 of file QwParameterFile.h.

References fCommentChars, and TrimComment().

Referenced by LineHasModuleHeader(), LineHasSectionHeader(), ReadNextLine_Greedy(), and TrimComment().

{ TrimComment(fCommentChars); };

Here is the call graph for this function:

Here is the caller graph for this function:

void QwParameterFile::TrimModuleHeader

(

)

Definition at line 440 of file QwParameterFile.cc.

References fLine, fModuleChars, and Trim().

{
  // Trim module delimiter character on both sides
  Trim(fModuleChars,fLine,TString::kBoth);
}

Here is the call graph for this function:

void QwParameterFile::TrimSectionHeader

(

)

Definition at line 434 of file QwParameterFile.cc.

References fLine, fSectionChars, and Trim().

Referenced by QwRegression::LoadChannelMap().

{
  // Trim section delimiter character on both sides
  Trim(fSectionChars,fLine,TString::kBoth);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwParameterFile::TrimWhitespace

(

TString::EStripType

head_tail = TString::kBoth

)

Definition at line 380 of file QwParameterFile.cc.

References fLine.

Referenced by QwEPICSEvent::ExtractEPICSValues(), QwEventBuffer::GetNextEventRange(), GetNextToken(), HasValue(), HasVariablePair(), LineHasModuleHeader(), LineHasSectionHeader(), QwRegression::LoadChannelMap(), QwBeamLine::LoadChannelMap(), QwMainCerenkovDetector::LoadChannelMap(), QwDetectorInfo::LoadCrosstalkDefinition(), VQwSubsystemTracking::LoadCrosstalkDefinition(), VQwSubsystem::LoadDetectorMaps(), QwDetectorInfo::LoadGeometryDefinition(), VQwSubsystemTracking::LoadGeometryDefinition(), QwHistogramHelper::LoadHistParamsFromFile(), QwHistogramHelper::LoadTreeParamsFromFile(), and ReadNextLine_Greedy().

{
  //  If the first bit is set, this routine removes leading spaces from the
  //  line.  If the second bit is set, this routine removes trailing spaces
  //  from the line.  The default behavior is to remove both.
  TrimWhitespace(fLine, head_tail);
}

Here is the caller graph for this function:

void QwParameterFile::TrimWhitespace ( std::string &  token, TString::EStripType  head_tail  )

protected

Definition at line 411 of file QwParameterFile.cc.

References fWhitespaceChars, and Trim().

{
  Trim(fWhitespaceChars,token,head_tail);
}

Here is the call graph for this function:

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  stream, const QwParameterFile &  file  )

friend

Todo:

TODO (wdc) operator<< on QwParameterFile requires RewindToFileStart

Definition at line 780 of file QwParameterFile.cc.

{
  /// \todo TODO (wdc) operator<< on QwParameterFile requires RewindToFileStart
  std::string line;
  stream << file.fStream.rdbuf();
  return stream;
}

Field Documentation

Bool_t QwParameterFile::fBeGreedy

protected

Definition at line 324 of file QwParameterFile.h.

Referenced by DisableGreediness(), EnableGreediness(), and ReadNextLine().

TString QwParameterFile::fBestParamFileName

private

Definition at line 265 of file QwParameterFile.h.

Referenced by GetParamFilename(), and SetParamFilename().

TString QwParameterFile::fBestParamFileNameAndPath

private

Definition at line 266 of file QwParameterFile.h.

Referenced by GetParameterFileContents(), GetParamFilenameAndPath(), OpenFile(), and SetParamFilename().

std::set<std::string> QwParameterFile::fBreakpointWords

protected

Definition at line 325 of file QwParameterFile.h.

Referenced by AddBreakpointKeyword(), and ReadNextLine_Greedy().

std::string QwParameterFile::fCommentChars

protected

Definition at line 290 of file QwParameterFile.h.

Referenced by SetCommentChars(), and TrimComment().

size_t QwParameterFile::fCurrentPos

protected

Internal line storage.

Definition at line 304 of file QwParameterFile.h.

Referenced by GetNextToken(), ReadNextLine(), ReadNextLine_Single(), and RewindToLineStart().

UInt_t QwParameterFile::fCurrentRunNumber = 0

staticprotected

Definition at line 280 of file QwParameterFile.h.

Referenced by FindFile(), and SetCurrentRunNumber().

std::ifstream QwParameterFile::fFile

protected

Definition at line 299 of file QwParameterFile.h.

Referenced by Close(), and OpenFile().

const std::string QwParameterFile::fFilename

protected

Definition at line 298 of file QwParameterFile.h.

Bool_t QwParameterFile::fHasNewPairs

protected

Definition at line 327 of file QwParameterFile.h.

Referenced by HasNewPairs(), and ReadNextLine_Greedy().

std::map<std::string, std::string> QwParameterFile::fKeyValuePair

protected

Definition at line 326 of file QwParameterFile.h.

Referenced by GetKeyValue(), and ReadNextLine_Greedy().

std::string QwParameterFile::fLine

protected

Definition at line 303 of file QwParameterFile.h.

Referenced by GetLine(), GetNextToken(), HasVariablePair(), LineHasModuleHeader(), LineHasSectionHeader(), LineIsEmpty(), ReadNextLine_Single(), TrimComment(), TrimModuleHeader(), TrimSectionHeader(), and TrimWhitespace().

std::string QwParameterFile::fModuleChars

protected

Definition at line 294 of file QwParameterFile.h.

Referenced by LineHasModuleHeader(), SetModuleChars(), and TrimModuleHeader().

std::vector< bfs::path > QwParameterFile::fSearchPaths

staticprotected

Definition at line 277 of file QwParameterFile.h.

Referenced by AppendToSearchPath(), and QwParameterFile().

std::string QwParameterFile::fSectionChars

protected

Definition at line 293 of file QwParameterFile.h.

Referenced by SetSectionChars(), and TrimSectionHeader().

std::stringstream QwParameterFile::fStream

protected

Definition at line 300 of file QwParameterFile.h.

Referenced by AddLine(), IsEOF(), OpenFile(), operator<<(), QwParameterFile(), rdbuf(), ReadNextLine_Single(), RewindToFileStart(), and SetEOF().

std::string QwParameterFile::fTokenSepChars

protected

Definition at line 292 of file QwParameterFile.h.

Referenced by GetNextToken(), and SetTokenSepChars().

std::string QwParameterFile::fWhitespaceChars

protected

Definition at line 291 of file QwParameterFile.h.

Referenced by SetWhitespaceChars(), and TrimWhitespace().

const std::string QwParameterFile::kDefaultCommentChars = "#!;"

staticprotected

Definition at line 283 of file QwParameterFile.h.

const std::string QwParameterFile::kDefaultModuleChars = "<>"

staticprotected

Definition at line 287 of file QwParameterFile.h.

const std::string QwParameterFile::kDefaultSectionChars = "[]"

staticprotected

Definition at line 286 of file QwParameterFile.h.

const std::string QwParameterFile::kDefaultTokenSepChars = ", \t"

staticprotected

Definition at line 285 of file QwParameterFile.h.

const std::string QwParameterFile::kDefaultWhitespaceChars = " \t\r"

staticprotected

Definition at line 284 of file QwParameterFile.h.

---

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

• QwParameterFile.h
• QwParameterFile.cc