VHISTlib  1.84.0.3018
Public Member Functions
vhist::ArgfileReader Class Reference

A class for reading VHIST argfiles. More...

#include <argfilereader.h>

Inheritance diagram for vhist::ArgfileReader:
vhist::LogSource

List of all members.

Public Member Functions

 ArgfileReader ()
 Creates a new ArgfileReader.
 ~ArgfileReader ()
 Destroys the ArgfileReader.
ArgFile readArgfile (const QString &content, const Environment *env=NULL)
 Parses the given argfile and generates an ArgFile object from it.

Detailed Description

A class for reading VHIST argfiles.

The class parses argfiles, replaces variables in the argfile and generates the result in an ArgFile object in a structured way.


Member Function Documentation

ArgFile ArgfileReader::readArgfile ( const QString &  content,
const Environment *  env = NULL 
)

Parses the given argfile and generates an ArgFile object from it.

An optional Environment containing environment variables and their values can be passed to the method. If env is NULL, variables inside the argfile will not be replaced.

Parameters:
contentThe content of the argfile, which should be read.
envAn optional hashtable containing environment variables. If a variable is used in the argfile but is not part of the environment, it is replaced by an empty string. If env is NULL, variables are not replaced.
Returns:
An ArgFile object representing the input argfile.

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

VHISTlib 1.84.0.3018 of Jun 28 2013, generated by doxygen.