Configuration file parser with flexible tokenization and search capabilities. More...

#include <QwParameterFile.h>

Collaboration diagram for QwParameterFile:

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.

void	SetCommentChars (const std::string value)
	Set various sets of special characters.

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.

std::string	GetNextToken ()

template<typename T>
T	GetTypedNextToken ()
	Get next token into specific type.

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)

template<typename T>
Bool_t	FileHasVariablePair (const std::string &separatorchars, const std::string &varname, T &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.

std::unique_ptr< QwParameterFile >	ReadSectionPreamble ()
	Rewinds to the start and read until it finds next section header.

std::unique_ptr< QwParameterFile >	ReadUntilNextSection (const bool add_current_line=false)

std::unique_ptr< QwParameterFile >	ReadNextSection (std::string &secname, const bool keep_header=false)

std::unique_ptr< QwParameterFile >	ReadNextSection (TString &secname, const bool keep_header=false)

std::unique_ptr< QwParameterFile >	ReadNextSection (const bool keep_header=false)

std::unique_ptr< QwParameterFile >	ReadModulePreamble ()
	Rewinds to the start and read until it finds next module header.

std::unique_ptr< QwParameterFile >	ReadUntilNextModule (const bool add_current_line=false)

std::unique_ptr< QwParameterFile >	ReadNextModule (std::string &secname, const bool keep_header=false)

std::unique_ptr< QwParameterFile >	ReadNextModule (TString &secname, const bool keep_header=false)

std::unique_ptr< 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.

template<>
UInt_t	ConvertValue (const std::string &value)

template<>
bool	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.

static void	SetCurrentRunNumber (const UInt_t runnumber)
	Set the current run number for looking up the appropriate parameter file.

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.

static int	ParseInt (const std::string &value)
	Parse an integer as #[kM] with optional metric scale factor.

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.

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.

Bool_t	fBeGreedy

std::set< std::string >	fBreakpointWords

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

Bool_t	fHasNewPairs

Static Protected Attributes
static std::vector< fs::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 fs::path &dir_path, const std::string &file_stem, const std::string &file_ext, fs::path &path_found)
	Find the first file in a directory that conforms to the run label.

bool	OpenFile (const fs::path &path_found)
	Open a file.

	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

Configuration file parser with flexible tokenization and search capabilities.

Provides parsing of configuration files with support for comments, section headers, variable substitution, file inclusion (append), and configurable token separators. Includes search path management and run-number-based parameter file selection. Used throughout the framework for loading detector maps, cut parameters, and subsystem configurations.

Definition at line 49 of file QwParameterFile.h.

Constructor & Destructor Documentation

◆ QwParameterFile() [1/4]

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 110 of file QwParameterFile.cc.

: fCommentChars(kDefaultCommentChars),
  fWhitespaceChars(kDefaultWhitespaceChars),
  fTokenSepChars(kDefaultTokenSepChars),
  fSectionChars(kDefaultSectionChars),
  fModuleChars(kDefaultModuleChars),
  fFilename(name),
  fBeGreedy(kFALSE)
{
  // Create a file from the name
  fs::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 {
 
    // Separate file in stem and extension
    std::string file_stem = file.stem().string();
    std::string file_ext = file.extension().string();
 
    // Find the best match
    Int_t best_score = 0;
    fs::path best_path;
    for (size_t i = 0; i < fSearchPaths.size(); i++) {
 
      fs::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;
  }
}

References QwLog::endl(), fBeGreedy, fCommentChars, fFilename, FindFile(), fModuleChars, fSearchPaths, fSectionChars, fTokenSepChars, fWhitespaceChars, kDefaultCommentChars, kDefaultModuleChars, kDefaultSectionChars, kDefaultTokenSepChars, kDefaultWhitespaceChars, Qw::kGreen, Qw::kNormal, OpenFile(), QwError, QwMessage, QwWarning, and SetEOF().

Referenced by operator<<, QwParameterFile(), and ReadNextLine_Single().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ QwParameterFile() [2/4]

QwParameterFile::QwParameterFile ( const std::stringstream & stream )

Constructor

Parameters

stream String stream for reading

Definition at line 91 of file QwParameterFile.cc.

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

References fBeGreedy, fCommentChars, fFilename, fModuleChars, fSectionChars, fStream, fTokenSepChars, fWhitespaceChars, kDefaultCommentChars, kDefaultModuleChars, kDefaultSectionChars, kDefaultTokenSepChars, and kDefaultWhitespaceChars.

◆ ~QwParameterFile()

virtual QwParameterFile::~QwParameterFile ( )

inlinevirtual

Definition at line 59 of file QwParameterFile.h.

59{ };

◆ QwParameterFile() [3/4]

QwParameterFile::QwParameterFile ( )

inlineprivate

Definition at line 349 of file QwParameterFile.h.

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

References fBeGreedy, fCommentChars, fCurrentPos, fFilename, fHasNewPairs, fModuleChars, fSectionChars, fTokenSepChars, fWhitespaceChars, kDefaultCommentChars, kDefaultModuleChars, kDefaultSectionChars, kDefaultTokenSepChars, and kDefaultWhitespaceChars.

Referenced by ReadUntilNextModule(), and ReadUntilNextSection().

Here is the caller graph for this function:

◆ QwParameterFile() [4/4]

QwParameterFile::QwParameterFile ( const QwParameterFile & input )

inlineprivate

Definition at line 362 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)
    { };

References fBeGreedy, fCommentChars, fCurrentPos, fFilename, fHasNewPairs, fModuleChars, fSectionChars, fTokenSepChars, fWhitespaceChars, and QwParameterFile().

Here is the call graph for this function:

Member Function Documentation

◆ AddBreakpointKeyword()

void QwParameterFile::AddBreakpointKeyword ( std::string keyname )

Definition at line 891 of file QwParameterFile.cc.

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

References fBreakpointWords.

Referenced by QwBeamLine::LoadChannelMap(), and QwScaler::LoadChannelMap().

Here is the caller graph for this function:

◆ AddLine()

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

inline

Definition at line 142 of file QwParameterFile.h.

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

References fStream.

◆ AppendToSearchPath()

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 34 of file QwParameterFile.cc.

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

References fSearchPaths.

Referenced by main(), and main().

Here is the caller graph for this function:

◆ Close()

void QwParameterFile::Close ( )

inline

Definition at line 220 of file QwParameterFile.h.

220{ fFile.close();};

QwParameterFile::fFile

std::ifstream fFile

Definition QwParameterFile.h:316

References fFile.

Referenced by QwBeamLine::LoadChannelMap(), QwEPICSEvent::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), VQwSubsystemParity::LoadEventCuts(), QwBeamLine::LoadGeometryDefinition(), QwBeamLine::LoadInputParameters(), QwScaler::LoadInputParameters(), VQwDetectorArray::LoadInputParameters(), and VQwDetectorArray::LoadMockDataParameters().

Here is the caller graph for this function:

◆ ConvertValue() [1/4]

template<typename T>

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

inline

Convert string value into specific type.

Definition at line 256 of file QwParameterFile.h.

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

Referenced by FileHasVariablePair(), GetTypedNextToken(), PopValue(), QwParameterFile::ConvertValue< std::string >(), and ReturnValue().

Here is the caller graph for this function:

◆ ConvertValue() [2/4]

template<>

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

inline

Definition at line 386 of file QwParameterFile.h.

                                                                          {
  return GetUInt(value);
}

References GetUInt().

Here is the call graph for this function:

◆ ConvertValue() [3/4]

template<>

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

inline

Definition at line 396 of file QwParameterFile.h.

                                                                      {
  bool retvalue;
  std::string str(value);
  std::transform(str.begin(), str.end(), str.begin(), ::tolower);
  std::istringstream stream1(str);
  if (isalpha(str[0]))
    stream1 >> std::boolalpha >> retvalue;
  else
    stream1 >> retvalue;
  return retvalue;
}

◆ ConvertValue() [4/4]

template<>

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

inline

Definition at line 409 of file QwParameterFile.h.

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

◆ DisableGreediness()

void QwParameterFile::DisableGreediness ( )

inline

Definition at line 216 of file QwParameterFile.h.

216{fBeGreedy=kFALSE;};

References fBeGreedy.

◆ EnableGreediness()

void QwParameterFile::EnableGreediness ( )

inline

Definition at line 215 of file QwParameterFile.h.

215{fBeGreedy=kTRUE;};

References fBeGreedy.

Referenced by QwBeamLine::LoadChannelMap(), QwBeamMod::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), and VQwDataHandler::ParseConfigFile().

Here is the caller graph for this function:

◆ FileHasModuleHeader() [1/2]

Bool_t QwParameterFile::FileHasModuleHeader ( const std::string & secname )

Definition at line 606 of file QwParameterFile.cc.

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

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

Referenced by QwBeamLine::ConstructBranch(), QwCombinerSubsystem::ConstructBranch(), and VQwDetectorArray::ConstructBranch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FileHasModuleHeader() [2/2]

Bool_t QwParameterFile::FileHasModuleHeader ( const TString & secname )

Definition at line 594 of file QwParameterFile.cc.

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

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

Here is the call graph for this function:

◆ FileHasSectionHeader() [1/2]

Bool_t QwParameterFile::FileHasSectionHeader ( const std::string & secname )

Definition at line 582 of file QwParameterFile.cc.

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

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

Referenced by QwSubsystemArray::ConstructBranch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FileHasSectionHeader() [2/2]

Bool_t QwParameterFile::FileHasSectionHeader ( const TString & secname )

Definition at line 570 of file QwParameterFile.cc.

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

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

Here is the call graph for this function:

◆ FileHasVariablePair() [1/3]

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

Definition at line 493 of file QwParameterFile.cc.

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

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

Referenced by FileHasVariablePair(), FileHasVariablePair(), and QwBlinder::QwBlinder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FileHasVariablePair() [2/3]

template<typename T>

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

inline

Definition at line 155 of file QwParameterFile.h.

                                                                                                       {
      std::string strvalue;
      Bool_t status = FileHasVariablePair(separatorchars, varname, strvalue);
      if (status){
    varvalue = ConvertValue<T>(strvalue);
      }
      return status;
    }

References ConvertValue(), and FileHasVariablePair().

Here is the call graph for this function:

◆ FileHasVariablePair() [3/3]

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

Definition at line 482 of file QwParameterFile.cc.

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

References FileHasVariablePair().

Here is the call graph for this function:

◆ FindFile()

int QwParameterFile::FindFile	(	const fs::path &	directory,
		const std::string &	file_stem,
		const std::string &	file_ext,
		fs::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 250 of file QwParameterFile.cc.

{
  // Return false if the directory does not exist
  if (! fs::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
  fs::directory_iterator end_iterator;
  for (fs::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
    std::string file_name = file_iterator->path().filename().string();
    // 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;
}

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

Referenced by QwParameterFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetKeyValue()

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 325 of file QwParameterFile.h.

                                            {
      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;
    }

References fKeyValuePair.

Referenced by PopValue(), and ReturnValue().

Here is the caller graph for this function:

◆ GetLine()

std::string QwParameterFile::GetLine ( )

inline

Definition at line 141 of file QwParameterFile.h.

141{ return fLine; };

QwParameterFile::fLine

std::string fLine

Definition QwParameterFile.h:320

References fLine.

Referenced by HasValue(), MQwMockable::LoadMockDataParameters(), QwBCM< T >::LoadMockDataParameters(), QwBPMStripline< T >::LoadMockDataParameters(), QwCombinedBCM< T >::LoadMockDataParameters(), QwCombinedBPM< T >::LoadMockDataParameters(), VQwDataHandler::ParseConfigFile(), ReadUntilNextModule(), and ReadUntilNextSection().

Here is the caller graph for this function:

◆ GetNextToken() [1/2]

std::string QwParameterFile::GetNextToken ( )

inline

Definition at line 133 of file QwParameterFile.h.

133{ return GetNextToken(fTokenSepChars); };

QwParameterFile::GetNextToken

std::string GetNextToken()

Definition QwParameterFile.h:133

References fTokenSepChars, and GetNextToken().

Referenced by GetNextToken(), and GetTypedNextToken().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNextToken() [2/2]

std::string QwParameterFile::GetNextToken ( const std::string & separatorchars )

Get next token as a string.

Definition at line 739 of file QwParameterFile.cc.

{
  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;
}

References fCurrentPos, fLine, and TrimWhitespace().

Referenced by LRBCorrector::LoadChannelMap(), QwAlarmHandler::LoadChannelMap(), QwCorrelator::LoadChannelMap(), QwScaler::LoadChannelMap(), MQwMockable::LoadMockDataParameters(), QwBCM< T >::LoadMockDataParameters(), QwBPMStripline< T >::LoadMockDataParameters(), QwCombinedBCM< T >::LoadMockDataParameters(), and QwCombinedBPM< T >::LoadMockDataParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetParameterFileContents()

TString QwParameterFile::GetParameterFileContents ( )

Definition at line 876 of file QwParameterFile.cc.

{
  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;
}

References fBestParamFileNameAndPath.

Referenced by GetParamFileNameContents().

Here is the caller graph for this function:

◆ GetParamFilename()

const TString QwParameterFile::GetParamFilename ( )

inline

Definition at line 206 of file QwParameterFile.h.

206{return fBestParamFileName;};

QwParameterFile::fBestParamFileName

TString fBestParamFileName

Definition QwParameterFile.h:280

References fBestParamFileName.

Referenced by GetParamFileNameContents(), and QwMollerDetector::LoadChannelMap().

Here is the caller graph for this function:

◆ GetParamFilenameAndPath()

const TString QwParameterFile::GetParamFilenameAndPath ( )

inline

Definition at line 207 of file QwParameterFile.h.

207{return fBestParamFileNameAndPath;};

References fBestParamFileNameAndPath.

◆ GetParamFileNameContents()

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

inline

Definition at line 209 of file QwParameterFile.h.

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

References GetParameterFileContents(), and GetParamFilename().

Referenced by QwBeamLine::LoadChannelMap(), QwBeamMod::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), VQwSubsystemParity::LoadEventCuts(), QwBeamLine::LoadGeometryDefinition(), QwBeamLine::LoadInputParameters(), QwScaler::LoadInputParameters(), VQwDetectorArray::LoadInputParameters(), QwBeamLine::LoadMockDataParameters(), and VQwDetectorArray::LoadMockDataParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypedNextToken()

template<typename T>

T QwParameterFile::GetTypedNextToken ( )

inline

Get next token into specific type.

Definition at line 137 of file QwParameterFile.h.

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

References ConvertValue(), and GetNextToken().

Referenced by QwBeamLine::AssignGeometry(), QwHistogramHelper::GetHistParamsFromFile(), QwHistogramHelper::GetHistParamsFromLine(), QwBeamLine::LoadChannelMap(), QwEPICSEvent::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwMollerDetector::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), QwBeamLine::LoadEventCuts_Line(), QwBeamMod::LoadEventCuts_Line(), VQwDetectorArray::LoadEventCuts_Line(), QwBeamLine::LoadGeometryDefinition(), QwBeamLine::LoadInputParameters(), QwBeamMod::LoadInputParameters(), QwScaler::LoadInputParameters(), VQwDetectorArray::LoadInputParameters(), MQwMockable::LoadMockDataParameters(), QwBCM< T >::LoadMockDataParameters(), QwBeamLine::LoadMockDataParameters(), QwBPMStripline< T >::LoadMockDataParameters(), QwCombinedBCM< T >::LoadMockDataParameters(), QwCombinedBPM< T >::LoadMockDataParameters(), VQwDetectorArray::LoadMockDataParameters(), QwBeamDetectorID::QwBeamDetectorID(), QwModChannelID::QwModChannelID(), and QwParameterFile::GetTypedNextToken< std::string >().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUInt()

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 53 of file QwParameterFile.cc.

{
  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;
}

Referenced by ConvertValue(), QwCombiner::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwSubsystem::LoadDetectorMaps(), VQwSubsystemParity::LoadEventCuts(), and QwHelicityCorrelatedFeedback::LoadParameterFile().

Here is the caller graph for this function:

◆ HasNewPairs()

Bool_t QwParameterFile::HasNewPairs ( )

inline

Definition at line 222 of file QwParameterFile.h.

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

References fHasNewPairs.

◆ HasValue()

Bool_t QwParameterFile::HasValue ( TString & vname )

Definition at line 424 of file QwParameterFile.cc.

{
  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;
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasVariablePair() [1/2]

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

Definition at line 462 of file QwParameterFile.cc.

{
  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;
}

References fLine, and TrimWhitespace().

Referenced by QwEPICSEvent::ExtractEPICSValues(), FileHasVariablePair(), HasVariablePair(), QwBeamLine::LoadChannelMap(), QwBeamMod::LoadChannelMap(), QwEPICSEvent::LoadChannelMap(), QwMollerDetector::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwSubsystem::LoadDetectorMaps(), VQwSubsystemParity::LoadEventCuts(), QwHelicityCorrelatedFeedback::LoadParameterFile(), ReadNextLine_Greedy(), and ReadNextLine_Single().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasVariablePair() [2/2]

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

Definition at line 448 of file QwParameterFile.cc.

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

References HasVariablePair().

Here is the call graph for this function:

◆ IsEOF()

Bool_t QwParameterFile::IsEOF ( )

inline

Definition at line 129 of file QwParameterFile.h.

129{ return fStream.eof();};

References fStream.

Referenced by QwHistogramHelper::LoadTreeParamsFromFile(), ReadNextModule(), ReadNextModule(), ReadNextSection(), and ReadNextSection().

Here is the caller graph for this function:

◆ LastString()

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

Definition at line 866 of file QwParameterFile.cc.

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

Referenced by SetParamFilename().

Here is the caller graph for this function:

◆ LineHasModuleHeader() [1/3]

Bool_t QwParameterFile::LineHasModuleHeader ( )

Definition at line 539 of file QwParameterFile.cc.

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

References LineHasModuleHeader().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LineHasModuleHeader() [2/3]

Bool_t QwParameterFile::LineHasModuleHeader ( std::string & secname )

Definition at line 553 of file QwParameterFile.cc.

{
  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_last_of(fModuleChars[1]);
    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;
}

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

Here is the call graph for this function:

◆ LineHasModuleHeader() [3/3]

Bool_t QwParameterFile::LineHasModuleHeader ( TString & secname )

Definition at line 545 of file QwParameterFile.cc.

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

References LineHasModuleHeader().

Here is the call graph for this function:

◆ LineHasSectionHeader() [1/3]

Bool_t QwParameterFile::LineHasSectionHeader ( )

Definition at line 509 of file QwParameterFile.cc.

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

References LineHasSectionHeader().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LineHasSectionHeader() [2/3]

Bool_t QwParameterFile::LineHasSectionHeader ( std::string & secname )

Definition at line 523 of file QwParameterFile.cc.

{
  TrimComment();
  Bool_t status = kFALSE;
  size_t equiv_pos1 = fLine.find_first_of(fSectionChars[0]);
  if (equiv_pos1 != std::string::npos) {
    size_t equiv_pos2 = fLine.find_last_of(fSectionChars[1]);
    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;
}

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

Here is the call graph for this function:

◆ LineHasSectionHeader() [3/3]

Bool_t QwParameterFile::LineHasSectionHeader ( TString & secname )

Definition at line 515 of file QwParameterFile.cc.

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

References LineHasSectionHeader().

Here is the call graph for this function:

◆ LineIsEmpty()

Bool_t QwParameterFile::LineIsEmpty ( )

inline

Definition at line 128 of file QwParameterFile.h.

128{return fLine.empty();};

References fLine.

Here is the caller graph for this function:

◆ OpenFile()

bool QwParameterFile::OpenFile ( const fs::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 194 of file QwParameterFile.cc.

{
  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
  check_whether_path_exists_and_is_a_regular_file = fs::exists(file) && fs::is_regular_file(file);
 
  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(); // disconnect 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;
}

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

Referenced by QwParameterFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseInt()

int QwParameterFile::ParseInt ( const std::string & value )

static

Parse an integer as #[kM] with optional metric scale factor.

Interpret an integer with optional scale factor.

Parameters

value String containing an integer with optional scale factor

Returns: Pure integer value with any scale factor applied

Definition at line 772 of file QwParameterFile.cc.

{
  int retval;
 
  const std::string scalechars("kM");
  size_t pos = value.find_first_of(scalechars);
  if (pos == std::string::npos) {
    //  Separator not found.
    retval = atoi(value.c_str());
  } else if (pos == value.length()-1) {
    retval = atoi(value.substr(0,pos).c_str());
    switch (value[pos]) {
      case 'k': retval *= 1e3; break;
      case 'M': retval *= 1e6; break;
      default:
        QwError << "Integer contains unknown scale factor! " << value << QwLog::endl;
        break;
    }
  } else {
    QwError << "Integer must end with scale factor! " << value << QwLog::endl;
    return INT_MAX;
  }
 
  //  Print the integer for debugging.
  QwVerbose << "The integer is " << retval << QwLog::endl;
 
  return retval;
}

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

Referenced by ParseIntRange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseIntRange()

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 815 of file QwParameterFile.cc.

{
  std::pair<int,int> mypair;
  size_t pos = range.find_first_of(separatorchars);
  if (pos == std::string::npos) {
    //  Separator not found.
    mypair.first  = ParseInt(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 = ParseInt(range.substr(pos+1, end).c_str());
    } else if (pos == range.length() - 1) {
      // Separator is the last character
      mypair.first  = ParseInt(range.substr(0,pos).c_str());
      mypair.second = INT_MAX;
    } else {
      mypair.first  = ParseInt(range.substr(0,pos).c_str());
      mypair.second = ParseInt(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 ("<< mypair.first<< ") must not be larger than the second value (" << mypair.second <<")"
        << 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;
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopValue()

template<typename T>

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

inline

Definition at line 238 of file QwParameterFile.h.

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

References ConvertValue(), and GetKeyValue().

Referenced by QwBeamLine::LoadChannelMap(), QwHelicity::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), LRBCorrector::ParseConfigFile(), QwAlarmHandler::ParseConfigFile(), QwCorrelator::ParseConfigFile(), VQwDataHandler::ParseConfigFile(), and VQwSubsystem::RegisterRocBankMarker().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rdbuf()

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

inline

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

Definition at line 62 of file QwParameterFile.h.

62{return fStream.rdbuf(); };

References fStream.

Referenced by QwOptions::ParseConfigFile(), and ReadNextLine_Single().

Here is the caller graph for this function:

◆ ReadModulePreamble()

std::unique_ptr< 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 713 of file QwParameterFile.cc.

{
  RewindToFileStart();
  return ReadUntilNextModule();
}

References ReadUntilNextModule(), and RewindToFileStart().

Here is the call graph for this function:

◆ ReadNextLine() [1/2]

Bool_t QwParameterFile::ReadNextLine ( )

inline

Definition at line 77 of file QwParameterFile.h.

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

References fCurrentPos, and ReadNextLine().

Referenced by QwEPICSEvent::ExtractEPICSValues(), FileHasModuleHeader(), FileHasModuleHeader(), FileHasSectionHeader(), FileHasSectionHeader(), FileHasVariablePair(), QwHistogramHelper::GetHistParamsFromFile(), HasValue(), QwSubsystemArray::LoadAllEventRanges(), LRBCorrector::LoadChannelMap(), QwAlarmHandler::LoadChannelMap(), QwBeamLine::LoadChannelMap(), QwBeamMod::LoadChannelMap(), QwCorrelator::LoadChannelMap(), QwEPICSEvent::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwMollerDetector::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), VQwSubsystem::LoadDetectorMaps(), VQwSubsystemParity::LoadEventCuts(), QwBeamLine::LoadGeometryDefinition(), QwHistogramHelper::LoadHistParamsFromFile(), QwBeamLine::LoadInputParameters(), QwBeamMod::LoadInputParameters(), QwScaler::LoadInputParameters(), VQwDetectorArray::LoadInputParameters(), QwBeamLine::LoadMockDataParameters(), VQwDetectorArray::LoadMockDataParameters(), QwHelicityCorrelatedFeedback::LoadParameterFile(), VQwDataHandler::ParseConfigFile(), ReadNextLine(), ReadNextLine_Single(), ReadNextModule(), ReadNextModule(), ReadNextSection(), ReadNextSection(), ReadUntilNextModule(), ReadUntilNextSection(), and SkipSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadNextLine() [2/2]

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

inline

Definition at line 82 of file QwParameterFile.h.

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

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

Here is the call graph for this function:

◆ ReadNextLine_Greedy()

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

Definition at line 897 of file QwParameterFile.cc.

{
  //  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);
      QwDebug << "QwParameterFile::ReadNextLine_Greedy: varname="
          << tmpname << "; varvalue=" << tmpvalue <<QwLog::endl;
      if (fBreakpointWords.count(tmpname)==1){
    RewindToLineStart();
    break;
      } else {
    fKeyValuePair[tmpname] = tmpvalue;
    fHasNewPairs = kTRUE;
    continue;
      }
    }
    break;
  }
  return status;
}

References QwLog::endl(), fBreakpointWords, fHasNewPairs, fKeyValuePair, HasVariablePair(), LineIsEmpty(), QwDebug, ReadNextLine_Single(), RewindToLineStart(), TrimComment(), and TrimWhitespace().

Referenced by ReadNextLine().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadNextLine_Single()

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

inline

Definition at line 89 of file QwParameterFile.h.

                                                    {
      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;
      }
    };

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

Referenced by ReadNextLine(), and ReadNextLine_Greedy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadNextModule() [1/3]

std::unique_ptr< QwParameterFile > QwParameterFile::ReadNextModule ( const bool keep_header = false )

inline

Definition at line 198 of file QwParameterFile.h.

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

References ReadNextModule().

Here is the call graph for this function:

◆ ReadNextModule() [2/3]

std::unique_ptr< QwParameterFile > QwParameterFile::ReadNextModule	(	std::string &	secname,
		const 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 725 of file QwParameterFile.cc.

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

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

Referenced by ReadNextModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadNextModule() [3/3]

std::unique_ptr< QwParameterFile > QwParameterFile::ReadNextModule	(	TString &	secname,
		const bool	keep_header = false )

Definition at line 732 of file QwParameterFile.cc.

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

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

Here is the call graph for this function:

◆ ReadNextSection() [1/3]

std::unique_ptr< QwParameterFile > QwParameterFile::ReadNextSection ( const bool keep_header = false )

inline

Definition at line 188 of file QwParameterFile.h.

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

References ReadNextSection().

Here is the call graph for this function:

◆ ReadNextSection() [2/3]

std::unique_ptr< 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 694 of file QwParameterFile.cc.

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

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

Referenced by QwBeamLine::LoadChannelMap(), QwCombiner::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), QwDataHandlerArray::LoadDataHandlersFromParameterFile(), QwPromptSummary::LoadElementsFromParameterFile(), QwSubsystemArrayParity::LoadMockDataParameters(), QwSubsystemArray::LoadSubsystemsFromParameterFile(), QwHistogramHelper::LoadTreeParamsFromFile(), and ReadNextSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadNextSection() [3/3]

std::unique_ptr< QwParameterFile > QwParameterFile::ReadNextSection	(	TString &	secname,
		const bool	keep_header = false )

Definition at line 701 of file QwParameterFile.cc.

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

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

Here is the call graph for this function:

◆ ReadSectionPreamble()

std::unique_ptr< 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 682 of file QwParameterFile.cc.

{
  RewindToFileStart();
  return ReadUntilNextSection();
}

References ReadUntilNextSection(), and RewindToFileStart().

Referenced by QwSubsystemArray::ConstructBranch(), QwCombiner::LoadChannelMap(), QwDataHandlerArray::LoadDataHandlersFromParameterFile(), QwPromptSummary::LoadElementsFromParameterFile(), QwSubsystemArrayParity::LoadMockDataParameters(), and QwSubsystemArray::LoadSubsystemsFromParameterFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadUntilNextModule()

std::unique_ptr< 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 637 of file QwParameterFile.cc.

{
  std::string nextheader; // dummy
  std::unique_ptr<QwParameterFile> section(new QwParameterFile()); // std::make_unique requires public c'tor
  if (add_current_line) section->AddLine(GetLine()); // add current line
  while (ReadNextLine() && ! LineHasModuleHeader(nextheader)) {
    section->AddLine(GetLine());
  }
  return section;
}

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

Referenced by QwBeamLine::ConstructBranch(), QwCombinerSubsystem::ConstructBranch(), VQwDetectorArray::ConstructBranch(), ReadModulePreamble(), ReadNextModule(), and ReadNextModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadUntilNextSection()

std::unique_ptr< 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 622 of file QwParameterFile.cc.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReturnValue()

template<typename T>

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

inline

Definition at line 229 of file QwParameterFile.h.

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

References ConvertValue(), and GetKeyValue().

Referenced by QwBeamLine::LoadChannelMap(), QwADC18_Channel::LoadChannelParameters(), QwMollerADC_Channel::LoadChannelParameters(), QwVQWK_Channel::LoadChannelParameters(), VQwScaler_Channel::LoadChannelParameters(), QwBeamDetectorID::QwBeamDetectorID(), and QwModChannelID::QwModChannelID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RewindToFileStart()

void QwParameterFile::RewindToFileStart ( )

inline

Definition at line 144 of file QwParameterFile.h.

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

References fStream.

Referenced by QwBeamLine::ConstructBranch(), QwCombinerSubsystem::ConstructBranch(), VQwDetectorArray::ConstructBranch(), FileHasModuleHeader(), FileHasModuleHeader(), FileHasSectionHeader(), FileHasSectionHeader(), FileHasVariablePair(), HasValue(), QwBeamLine::LoadChannelMap(), QwCombiner::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), VQwSubsystem::LoadDetectorMaps(), VQwDataHandler::ParseConfigFile(), ReadModulePreamble(), and ReadSectionPreamble().

Here is the caller graph for this function:

◆ RewindToLineStart()

void QwParameterFile::RewindToLineStart ( )

inline

Definition at line 145 of file QwParameterFile.h.

145{ fCurrentPos = 0; };

References fCurrentPos.

Referenced by QwHistogramHelper::GetHistParamsFromFile(), and ReadNextLine_Greedy().

Here is the caller graph for this function:

◆ SetCommentChars()

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

inline

Set various sets of special characters.

Definition at line 71 of file QwParameterFile.h.

71{ fCommentChars = value; };

References fCommentChars.

Referenced by QwBeamLine::LoadChannelMap(), QwBeamMod::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwScaler::LoadChannelMap(), and VQwDetectorArray::LoadChannelMap().

Here is the caller graph for this function:

◆ SetCurrentRunNumber()

static void QwParameterFile::SetCurrentRunNumber ( const UInt_t runnumber )

inlinestatic

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

Definition at line 68 of file QwParameterFile.h.

68{ fCurrentRunNumber = runnumber; };

References fCurrentRunNumber.

Referenced by main().

Here is the caller graph for this function:

◆ SetEOF()

void QwParameterFile::SetEOF ( )

inlineprivate

Definition at line 375 of file QwParameterFile.h.

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

References fStream.

Referenced by QwParameterFile().

Here is the caller graph for this function:

◆ SetModuleChars()

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

inline

Definition at line 75 of file QwParameterFile.h.

75{ fModuleChars = value; };

References fModuleChars.

◆ SetParamFilename()

void QwParameterFile::SetParamFilename ( )

Definition at line 858 of file QwParameterFile.cc.

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

References fBestParamFileName, fBestParamFileNameAndPath, and LastString().

Referenced by OpenFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSectionChars()

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

inline

Definition at line 74 of file QwParameterFile.h.

74{ fSectionChars = value; };

References fSectionChars.

◆ SetTokenSepChars()

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

inline

Definition at line 73 of file QwParameterFile.h.

73{ fTokenSepChars = value; };

References fTokenSepChars.

◆ SetWhitespaceChars()

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

inline

Definition at line 72 of file QwParameterFile.h.

72{ fWhitespaceChars = value; };

References fWhitespaceChars.

◆ SkipSection()

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 648 of file QwParameterFile.cc.

{
  //  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;
}

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

Referenced by QwBeamLine::LoadChannelMap(), and SkipSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Trim()

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

protected

Definition at line 365 of file QwParameterFile.cc.

{
  //  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);
  }
}

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

Here is the caller graph for this function:

◆ TrimComment() [1/3]

void QwParameterFile::TrimComment ( )

inline

Definition at line 121 of file QwParameterFile.h.

121{ TrimComment(fCommentChars); };

References fCommentChars, and TrimComment().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrimComment() [2/3]

void QwParameterFile::TrimComment ( const char commentchar )

Definition at line 395 of file QwParameterFile.cc.

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

References TrimComment().

Referenced by QwHistogramHelper::GetHistParamsFromFile(), QwSubsystemArray::LoadAllEventRanges(), LRBCorrector::LoadChannelMap(), QwAlarmHandler::LoadChannelMap(), QwCorrelator::LoadChannelMap(), QwEPICSEvent::LoadChannelMap(), QwMollerDetector::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), VQwSubsystem::LoadDetectorMaps(), VQwSubsystemParity::LoadEventCuts(), QwBeamLine::LoadGeometryDefinition(), QwHistogramHelper::LoadHistParamsFromFile(), QwBeamLine::LoadInputParameters(), QwBeamMod::LoadInputParameters(), QwScaler::LoadInputParameters(), VQwDetectorArray::LoadInputParameters(), QwBeamLine::LoadMockDataParameters(), VQwDetectorArray::LoadMockDataParameters(), and QwHelicityCorrelatedFeedback::LoadParameterFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrimComment() [3/3]

void QwParameterFile::TrimComment ( const std::string & commentchars )

Definition at line 402 of file QwParameterFile.cc.

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

References fLine.

◆ TrimModuleHeader()

void QwParameterFile::TrimModuleHeader ( )

Definition at line 417 of file QwParameterFile.cc.

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

References fLine, fModuleChars, and Trim().

Here is the call graph for this function:

◆ TrimSectionHeader()

void QwParameterFile::TrimSectionHeader ( )

Definition at line 411 of file QwParameterFile.cc.

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

References fLine, fSectionChars, and Trim().

Here is the call graph for this function:

◆ TrimWhitespace() [1/2]

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

protected

Definition at line 388 of file QwParameterFile.cc.

{
  Trim(fWhitespaceChars,token,head_tail);
}

References fWhitespaceChars, and Trim().

Here is the call graph for this function:

◆ TrimWhitespace() [2/2]

void QwParameterFile::TrimWhitespace ( TString::EStripType head_tail = TString::kBoth )

Definition at line 357 of file QwParameterFile.cc.

{
  //  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);
}

References fLine, and TrimWhitespace().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ operator<<

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

friend

Todo: TODO (wdc) operator<< on QwParameterFile requires RewindToFileStart

Definition at line 757 of file QwParameterFile.cc.

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

References fStream, and QwParameterFile().

Field Documentation

◆ fBeGreedy

Bool_t QwParameterFile::fBeGreedy

protected

Definition at line 341 of file QwParameterFile.h.

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

◆ fBestParamFileName

TString QwParameterFile::fBestParamFileName

private

Definition at line 280 of file QwParameterFile.h.

Referenced by GetParamFilename(), and SetParamFilename().

◆ fBestParamFileNameAndPath

TString QwParameterFile::fBestParamFileNameAndPath

private

Definition at line 281 of file QwParameterFile.h.

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

◆ fBreakpointWords

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

protected

Definition at line 342 of file QwParameterFile.h.

Referenced by AddBreakpointKeyword(), and ReadNextLine_Greedy().

◆ fCommentChars

std::string QwParameterFile::fCommentChars

protected

Definition at line 307 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), QwParameterFile(), QwParameterFile(), SetCommentChars(), and TrimComment().

◆ fCurrentPos

size_t QwParameterFile::fCurrentPos

protected

Internal line storage.

Definition at line 321 of file QwParameterFile.h.

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

◆ fCurrentRunNumber

UInt_t QwParameterFile::fCurrentRunNumber = 0

staticprotected

Definition at line 297 of file QwParameterFile.h.

Referenced by FindFile(), and SetCurrentRunNumber().

◆ fFile

std::ifstream QwParameterFile::fFile

protected

Definition at line 316 of file QwParameterFile.h.

Referenced by Close(), and OpenFile().

◆ fFilename

const std::string QwParameterFile::fFilename

protected

Definition at line 315 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), QwParameterFile(), and QwParameterFile().

◆ fHasNewPairs

Bool_t QwParameterFile::fHasNewPairs

protected

Definition at line 344 of file QwParameterFile.h.

Referenced by HasNewPairs(), QwParameterFile(), QwParameterFile(), and ReadNextLine_Greedy().

◆ fKeyValuePair

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

protected

Definition at line 343 of file QwParameterFile.h.

Referenced by GetKeyValue(), and ReadNextLine_Greedy().

◆ fLine

std::string QwParameterFile::fLine

protected

Definition at line 320 of file QwParameterFile.h.

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

◆ fModuleChars

std::string QwParameterFile::fModuleChars

protected

Definition at line 311 of file QwParameterFile.h.

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

◆ fSearchPaths

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

staticprotected

Definition at line 294 of file QwParameterFile.h.

Referenced by AppendToSearchPath(), and QwParameterFile().

◆ fSectionChars

std::string QwParameterFile::fSectionChars

protected

Definition at line 310 of file QwParameterFile.h.

Referenced by LineHasSectionHeader(), QwParameterFile(), QwParameterFile(), QwParameterFile(), QwParameterFile(), SetSectionChars(), and TrimSectionHeader().

◆ fStream

std::stringstream QwParameterFile::fStream

protected

Definition at line 317 of file QwParameterFile.h.

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

◆ fTokenSepChars

std::string QwParameterFile::fTokenSepChars

protected

Definition at line 309 of file QwParameterFile.h.

Referenced by GetNextToken(), QwParameterFile(), QwParameterFile(), QwParameterFile(), QwParameterFile(), and SetTokenSepChars().

◆ fWhitespaceChars

std::string QwParameterFile::fWhitespaceChars

protected

Definition at line 308 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), QwParameterFile(), QwParameterFile(), SetWhitespaceChars(), and TrimWhitespace().

◆ kDefaultCommentChars

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

staticprotected

Definition at line 300 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), and QwParameterFile().

◆ kDefaultModuleChars

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

staticprotected

Definition at line 304 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), and QwParameterFile().

◆ kDefaultSectionChars

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

staticprotected

Definition at line 303 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), and QwParameterFile().

◆ kDefaultTokenSepChars

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

staticprotected

Definition at line 302 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), and QwParameterFile().

◆ kDefaultWhitespaceChars

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

staticprotected

Definition at line 301 of file QwParameterFile.h.

Referenced by QwParameterFile(), QwParameterFile(), and QwParameterFile().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ QwParameterFile() [1/4]

◆ QwParameterFile() [2/4]

◆ ~QwParameterFile()

◆ QwParameterFile() [3/4]

◆ QwParameterFile() [4/4]

Member Function Documentation

◆ AddBreakpointKeyword()

◆ AddLine()

◆ AppendToSearchPath()

◆ Close()

◆ ConvertValue() [1/4]

◆ ConvertValue() [2/4]

◆ ConvertValue() [3/4]

◆ ConvertValue() [4/4]

◆ DisableGreediness()

◆ EnableGreediness()

◆ FileHasModuleHeader() [1/2]

◆ FileHasModuleHeader() [2/2]

◆ FileHasSectionHeader() [1/2]

◆ FileHasSectionHeader() [2/2]

◆ FileHasVariablePair() [1/3]

◆ FileHasVariablePair() [2/3]

◆ FileHasVariablePair() [3/3]

◆ FindFile()

◆ GetKeyValue()

◆ GetLine()

◆ GetNextToken() [1/2]

◆ GetNextToken() [2/2]

◆ GetParameterFileContents()

◆ GetParamFilename()

◆ GetParamFilenameAndPath()

◆ GetParamFileNameContents()

◆ GetTypedNextToken()

◆ GetUInt()

◆ HasNewPairs()

◆ HasValue()

◆ HasVariablePair() [1/2]

◆ HasVariablePair() [2/2]

◆ IsEOF()

◆ LastString()

◆ LineHasModuleHeader() [1/3]

◆ LineHasModuleHeader() [2/3]

◆ LineHasModuleHeader() [3/3]

◆ LineHasSectionHeader() [1/3]

◆ LineHasSectionHeader() [2/3]

◆ LineHasSectionHeader() [3/3]

◆ LineIsEmpty()

◆ OpenFile()

◆ ParseInt()

◆ ParseIntRange()

◆ PopValue()

◆ rdbuf()

◆ ReadModulePreamble()

◆ ReadNextLine() [1/2]

◆ ReadNextLine() [2/2]

◆ ReadNextLine_Greedy()

◆ ReadNextLine_Single()

◆ ReadNextModule() [1/3]

◆ ReadNextModule() [2/3]

◆ ReadNextModule() [3/3]

◆ ReadNextSection() [1/3]

◆ ReadNextSection() [2/3]

◆ ReadNextSection() [3/3]

◆ ReadSectionPreamble()

◆ ReadUntilNextModule()

◆ ReadUntilNextSection()

◆ ReturnValue()

◆ RewindToFileStart()

◆ RewindToLineStart()

◆ SetCommentChars()