AmpTools
Public Member Functions | Static Public Member Functions | List of all members
ConfigFileParser Class Reference

#include <ConfigFileParser.h>

Public Member Functions

 ConfigFileParser ()
 
 ConfigFileParser (const string &configFile)
 
 ConfigFileParser (istream &input)
 
void readConfigFile (const string &configFile)
 
void readConfigFile (istream &input)
 
 ~ConfigFileParser ()
 
ConfigurationInfo * getConfigurationInfo ()
 
const vector< ConfigFileLine > & getConfigFileLines () const
 
void displayConfigFile () const
 

Static Public Member Functions

static void setVerboseParsing (bool verboseParsing=false)
 

Detailed Description

Definition at line 104 of file ConfigFileParser.h.

Constructor & Destructor Documentation

◆ ConfigFileParser() [1/3]

ConfigFileParser::ConfigFileParser ( )

Default constructor.

Definition at line 54 of file ConfigFileParser.cc.

◆ ConfigFileParser() [2/3]

ConfigFileParser::ConfigFileParser ( const string &  configFile)

A constructor that takes the name of a file as input.

Definition at line 60 of file ConfigFileParser.cc.

Here is the call graph for this function:

◆ ConfigFileParser() [3/3]

ConfigFileParser::ConfigFileParser ( istream &  input)

A constructor that takes a stream as input.

Definition at line 69 of file ConfigFileParser.cc.

Here is the call graph for this function:

◆ ~ConfigFileParser()

ConfigFileParser::~ConfigFileParser ( )
inline

The destructor.

Definition at line 152 of file ConfigFileParser.h.

Member Function Documentation

◆ displayConfigFile()

void ConfigFileParser::displayConfigFile ( ) const

Displays the final parsed vector of ConfigFileLine.

Definition at line 790 of file ConfigFileParser.cc.

◆ getConfigFileLines()

const vector<ConfigFileLine>& ConfigFileParser::getConfigFileLines ( ) const
inline

Returns a vector of ConfigFileLine, which includes all parsed information (with expanded "include" and "define" statements).

Definition at line 167 of file ConfigFileParser.h.

◆ getConfigurationInfo()

ConfigurationInfo* ConfigFileParser::getConfigurationInfo ( )
inline

Returns a pointer to a filled ConfigurationInfo object.

Definition at line 159 of file ConfigFileParser.h.

Here is the caller graph for this function:

◆ readConfigFile() [1/2]

void ConfigFileParser::readConfigFile ( const string &  configFile)

A method to read configuration information from a file. Use this in conjunction with the default constructor as an alternative to the ConfigFileParser(string configFile) constructor.

Definition at line 78 of file ConfigFileParser.cc.

Here is the caller graph for this function:

◆ readConfigFile() [2/2]

void ConfigFileParser::readConfigFile ( istream &  input)

A method to read configuration information from a stream. Use this in conjunction with the default constructor as an alternative to the ConfigFileParser(istream input) constructor.

Definition at line 90 of file ConfigFileParser.cc.

Here is the call graph for this function:

◆ setVerboseParsing()

static void ConfigFileParser::setVerboseParsing ( bool  verboseParsing = false)
inlinestatic

Control the level of output printed while parsing (useful for debugging).

Definition at line 181 of file ConfigFileParser.h.

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