lsst::meas::algorithms::shapelet::ConfigFile Class Reference

#include <ConfigFile.h>

Public Member Functions
	ConfigFile ()
	ConfigFile (const std::string fileName, const std::string delimiter="=", const std::string comment="#", const std::string include="+", const std::string sentry="EndConfigFile")
void	load (const std::string fileName)
void	load (const std::string fileName, const std::string delimiter, const std::string comment="", const std::string include="", const std::string sentry="")
void	read (std::istream &is)
void	append (const std::string &s)
void	write (std::ostream &os) const
void	writeAsComment (std::ostream &os) const
ConvertibleString &	getNoCheck (const std::string &key)
ConvertibleString	get (const std::string &key) const
ConvertibleString &	operator[] (const std::string &key)
ConvertibleString	operator[] (const std::string &key) const
template<typename T >
T	read (const std::string &key) const
template<typename T >
T	read (const std::string &key, const T &value) const
template<typename T >
bool	readInto (T &var, const std::string &key) const
template<typename T >
bool	readInto (T &var, const std::string &key, const T &value) const
std::string	getstr (const std::string key) const throw (const char*)
std::string	getstr (const std::string key, const std::string defval)
template<typename T >
void	add (std::string key, const T &value)
void	remove (const std::string &key)
bool	keyExists (const std::string &key) const
std::string	getDelimiter () const
std::string	getComment () const
std::string	getInclude () const
std::string	getSentry () const
std::string	setDelimiter (const std::string &s)
std::string	setComment (const std::string &s)
std::string	setInclude (const std::string &s)
std::string	setSentry (const std::string &s)
size_t	size ()

Protected Types
typedef std::map< std::string, ConvertibleString >::iterator	MapIt
typedef std::map< std::string, ConvertibleString > ::const_iterator	MapCIt

Static Protected Member Functions
static void	trim (std::string &s)

Protected Attributes
std::string	_delimiter
std::string	_comment
std::string	_include
std::string	_sentry
std::map< std::string, ConvertibleString >	_contents

Detailed Description

Definition at line 239 of file ConfigFile.h.

Member Typedef Documentation

typedef std::map<std::string,ConvertibleString>::const_iterator lsst::meas::algorithms::shapelet::ConfigFile::MapCIt

protected

Definition at line 338 of file ConfigFile.h.

typedef std::map<std::string,ConvertibleString>::iterator lsst::meas::algorithms::shapelet::ConfigFile::MapIt

protected

Definition at line 337 of file ConfigFile.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::shapelet::ConfigFile::ConfigFile

(

)

Definition at line 9 of file ConfigFile.cc.

                       :
    _delimiter("="), _comment("#"), _include("+"), _sentry("EndConfigFile")
{
    // Construct an empty ConfigFile
}

lsst::meas::algorithms::shapelet::ConfigFile::ConfigFile	(	const std::string	fileName,
		const std::string	delimiter = "=",
		const std::string	comment = "#",
		const std::string	include = "+",
		const std::string	sentry = "EndConfigFile"
	)

Definition at line 15 of file ConfigFile.cc.

                                                                           : 
    _delimiter(delimiter), _comment(comment), _include(inc), _sentry(sentry)
{
    // Construct a ConfigFile, getting keys and values from given file

    std::ifstream in( fileName.c_str() );

    if( !in ) {
#ifdef NOTHROW
        std::cerr<<"File not found: "<<fileName<<std::endl; 
        exit(1); 
#else
        throw FileNotFoundError(fileName);
#endif
    }

    in >> (*this);
}

Member Function Documentation

template<typename T >

void lsst::meas::algorithms::shapelet::ConfigFile::add ( std::string  key, const T &  value  )

inline

Definition at line 459 of file ConfigFile.h.

    {
        // Add a key with given value
        trim(key);
        _contents[key] = value;
    }

void lsst::meas::algorithms::shapelet::ConfigFile::append ( const std::string &  s )

inline

Definition at line 268 of file ConfigFile.h.

        { std::istringstream ss(s); read(ss); }

ConvertibleString lsst::meas::algorithms::shapelet::ConfigFile::get

(

const std::string &

key

)

const

Definition at line 79 of file ConfigFile.cc.

{
    std::string key2 = key;
    trim(key2);
    MapCIt p = _contents.find(key2);
    if (p == _contents.end()) {
#ifdef NOTHROW
        std::cerr<<"Key not found: "<<key2<<std::endl; 
        exit(1); return key; 
#else
        throw ParameterException(
            "ConfigFile error: key "+key2+" not found");
#endif
    } else {
        return p->second;
    }
}

std::string lsst::meas::algorithms::shapelet::ConfigFile::getComment ( ) const

inline

Definition at line 311 of file ConfigFile.h.

{ return _comment; }

std::string lsst::meas::algorithms::shapelet::ConfigFile::getDelimiter ( ) const

inline

Definition at line 310 of file ConfigFile.h.

{ return _delimiter; }

std::string lsst::meas::algorithms::shapelet::ConfigFile::getInclude ( ) const

inline

Definition at line 312 of file ConfigFile.h.

{ return _include; }

ConvertibleString & lsst::meas::algorithms::shapelet::ConfigFile::getNoCheck

(

const std::string &

key

)

Definition at line 72 of file ConfigFile.cc.

{
    std::string key2 = key;
    trim(key2);
    return _contents[key2]; 
}

std::string lsst::meas::algorithms::shapelet::ConfigFile::getSentry ( ) const

inline

Definition at line 313 of file ConfigFile.h.

{ return _sentry; }

std::string lsst::meas::algorithms::shapelet::ConfigFile::getstr	(	const std::string	key	)	const
throw	(	const char *
	)

Definition at line 101 of file ConfigFile.cc.

                                                                          {
  MapCIt p = _contents.find(key);

  if (p == _contents.end()) {
    std::stringstream err;
    err<<"ConfigFile error: key '"<<key<<"' not found";
    throw err.str().c_str();
  }

  std::string val = get(key);
  return val;
}

std::string lsst::meas::algorithms::shapelet::ConfigFile::getstr	(	const std::string	key,
		const std::string	defval
	)

Definition at line 114 of file ConfigFile.cc.

                            {
  MapCIt p = _contents.find(key);

  std::string val;
  if (p == _contents.end()) {
    val = defval;
  } else {
    val = get(key);
  }
  return val;
}

bool lsst::meas::algorithms::shapelet::ConfigFile::keyExists

(

const std::string &

key

)

const

Definition at line 139 of file ConfigFile.cc.

{
    // Indicate whether key is found
    MapCIt p = _contents.find( key );
    return ( p != _contents.end() );
}

void lsst::meas::algorithms::shapelet::ConfigFile::load ( const std::string  fileName )

inline

Definition at line 254 of file ConfigFile.h.

        { std::ifstream fs(fileName.c_str()); read(fs); }

void lsst::meas::algorithms::shapelet::ConfigFile::load	(	const std::string	fileName,
		const std::string	delimiter,
		const std::string	comment = "",
		const std::string	include = "",
		const std::string	sentry = ""
	)

Definition at line 36 of file ConfigFile.cc.

{
    // Construct a ConfigFile, getting keys and values from given file

    // the old values
    std::string delimiter1 = _delimiter;
    std::string comment1 = _comment;
    std::string inc1 = _include;
    std::string sentry1 = _sentry;

    if (delimiter != "") _delimiter = delimiter;
    if (comment != "") _comment = comment;
    if (inc != "") _include = inc;
    if (sentry != "") _sentry = sentry;

    std::ifstream in( fileName.c_str() );

    if( !in ) {
#ifdef NOTHROW
        std::cerr<<"File not found: "<<fileName<<std::endl; 
        exit(1); 
#else
        throw FileNotFoundError(fileName);
#endif
    }

    in >> (*this);

    _delimiter = delimiter1;
    _comment = comment1;
    _include = inc1;
    _sentry = sentry1;
}

ConvertibleString& lsst::meas::algorithms::shapelet::ConfigFile::operator[] ( const std::string &  key )

inline

Definition at line 279 of file ConfigFile.h.

        { return getNoCheck(key); }

ConvertibleString lsst::meas::algorithms::shapelet::ConfigFile::operator[] ( const std::string &  key ) const

inline

Definition at line 281 of file ConfigFile.h.

        { return get(key); }

void lsst::meas::algorithms::shapelet::ConfigFile::read

(

std::istream &

is

)

Definition at line 178 of file ConfigFile.cc.

{
    // Load a ConfigFile from is
    // Read in keys and values, keeping internal whitespace
    const std::string& delim = _delimiter;  // separator
    const std::string& comm = _comment;    // comment
    const std::string& inc = _include;      // include directive
    const std::string& sentry = _sentry;     // end of file sentry
    const std::string::size_type skip = delim.size(); // length of separator

    std::string nextLine = "";  
    // might need to read ahead to see where value ends

    while( is || nextLine.size() > 0 ) {
        // Read an entire line at a time
        std::string line;
        if( nextLine.size() > 0 ) {
            line = nextLine;  // we read ahead; use it now
            nextLine = "";
        } else {
            std::getline( is, line );
        }

        // Ignore comments
        line = line.substr( 0, line.find(comm) );

        // Remove leading and trailing whitespace
        trim(line);

        // If line is blank, go on to next line.
        if (line.size() == 0) continue;

        // Check for include directive (only at start of line)
        if (line.find(inc) == 0) { 
            line.erase(0,inc.size());
            std::stringstream ss(line);
            std::string fileName;
            ss >> fileName;
            load(fileName);
            // implcitly skip the rest of the line.
            continue;
        }

        // Check for end of file sentry
        if( sentry != "" && line.find(sentry) != std::string::npos ) return;

        // Parse the line if it contains a delimiter
        std::string::size_type delimPos = line.find( delim );
        if( delimPos < std::string::npos ) {
            // Extract the key
            std::string key = line.substr( 0, delimPos );
            line.replace( 0, delimPos+skip, "" );

            // See if value continues on the next line
            // Stop at blank line, next line with a key, end of stream,
            // or end of file sentry
            bool terminate = false;
            while( !terminate && is ) {
                std::getline( is, nextLine );
                terminate = true;

                std::string nextLineCopy = nextLine;
                ConfigFile::trim(nextLineCopy);
                if( nextLineCopy == "" ) continue;

                nextLine = nextLine.substr( 0, nextLine.find(comm) );
                if( nextLine.find(delim) != std::string::npos )
                    continue;
                if( sentry != "" && nextLine.find(sentry) != std::string::npos )
                    continue;

                nextLineCopy = nextLine;
                ConfigFile::trim(nextLineCopy);
                if( nextLineCopy != "" ) line += "\n";
                line += nextLine;
                terminate = false;
            }

            // Store key and value
            ConfigFile::trim(key);
            ConfigFile::trim(line);
            _contents[key] = line;  // overwrites if key is repeated
        }
    }
}

template<typename T >

T lsst::meas::algorithms::shapelet::ConfigFile::read ( const std::string &  key ) const

inline

Definition at line 347 of file ConfigFile.h.

    {
        // Read the value corresponding to key
        std::string key2 = key;
        trim(key2);
        MapCIt p = _contents.find(key2);
        if(p == _contents.end()) {
#ifdef NOTHROW
            std::cerr<<"Key not found: "<<key2<<std::endl; 
            exit(1); 
#else
            throw ParameterException(
                "ConfigFile error: key "+key2+" not found");
#endif
        }
        T ret;
        try {
            ret = p->second;
        } catch (ParameterException& e) {
            xdbg<<"Caught ParameterException: \n"<<e.what()<<std::endl;
            throw ParameterException(
                "ConfigFile error: Could not convert entry for key " +
                key2 +
                " to given type.\nCaught error from ConvertibleString: \n" +
                e.what());
        }
        return ret;
    }

template<typename T >

T lsst::meas::algorithms::shapelet::ConfigFile::read ( const std::string &  key, const T &  value  ) const

inline

Definition at line 378 of file ConfigFile.h.

    {
        // Return the value corresponding to key or given default value
        // if key is not found
        std::string key2 = key;
        trim(key2);
        MapCIt p = _contents.find(key2);
        if(p == _contents.end()) {
            return value;
        } else {
            T ret;
            try {
                ret = p->second;
            } catch (ParameterException& e) {
                xdbg<<"Caught ParameterException: \n"<<e.what()<<std::endl;
                throw ParameterException(
                    "ConfigFile error: Could not convert entry for key " +
                    key2 +
                    " to given type.\nCaught error from ConvertibleString: \n" +
                    e.what());
            }
            return ret;
        }
    }

template<typename T >

bool lsst::meas::algorithms::shapelet::ConfigFile::readInto ( T &  var, const std::string &  key  ) const

inline

Definition at line 405 of file ConfigFile.h.

    {
        // Get the value corresponding to key and store in var
        // Return true if key is found
        // Otherwise leave var untouched
        std::string key2 = key;
        trim(key2);
        MapCIt p = _contents.find(key2);
        bool isFound = ( p != _contents.end() );
        if(isFound) {
            try {
                var = p->second;
            } catch (ParameterException& e) {
                xdbg<<"Caught ParameterException: \n"<<e.what()<<std::endl;
                throw ParameterException(
                    "ConfigFile error: Could not convert entry for key " +
                    key2 +
                    " to given type.\nCaught error from ConvertibleString: \n" +
                    e.what());
            }
        }
        return isFound;
    }

template<typename T >

bool lsst::meas::algorithms::shapelet::ConfigFile::readInto ( T &  var, const std::string &  key, const T &  value  ) const

inline

Definition at line 431 of file ConfigFile.h.

    {
        // Get the value corresponding to key and store in var
        // Return true if key is found
        // Otherwise set var to given default
        std::string key2 = key;
        trim(key2);
        MapCIt p = _contents.find(key2);
        bool isFound = ( p != _contents.end() );
        if(isFound) {
            try {
                var = p->second;
            } catch (ParameterException& e) {
                xdbg<<"Caught ParameterException: \n"<<e.what()<<std::endl;
                throw ParameterException(
                    "ConfigFile error: Could not convert entry for key " +
                    key2 +
                    " to given type.\nCaught error from ConvertibleString: \n" +
                    e.what());
            }
        } else {
            var = value;
        }
        return isFound;
    }

void lsst::meas::algorithms::shapelet::ConfigFile::remove

(

const std::string &

key

)

Definition at line 131 of file ConfigFile.cc.

{
    // Remove key and its value
    _contents.erase( _contents.find( key ) );
    return;
}

std::string lsst::meas::algorithms::shapelet::ConfigFile::setComment ( const std::string &  s )

inline

Definition at line 317 of file ConfigFile.h.

        { std::string old = _comment;  _comment = s;  return old; }

std::string lsst::meas::algorithms::shapelet::ConfigFile::setDelimiter ( const std::string &  s )

inline

Definition at line 315 of file ConfigFile.h.

        { std::string old = _delimiter;  _delimiter = s;  return old; }  

std::string lsst::meas::algorithms::shapelet::ConfigFile::setInclude ( const std::string &  s )

inline

Definition at line 319 of file ConfigFile.h.

        { std::string old = _include;  _include = s;  return old; }  

std::string lsst::meas::algorithms::shapelet::ConfigFile::setSentry ( const std::string &  s )

inline

Definition at line 321 of file ConfigFile.h.

        { std::string old = _sentry;  _sentry = s;  return old; }  

size_t lsst::meas::algorithms::shapelet::ConfigFile::size ( )

inline

Definition at line 324 of file ConfigFile.h.

{ return _contents.size(); }

void lsst::meas::algorithms::shapelet::ConfigFile::trim ( std::string &  s )

staticprotected

Definition at line 147 of file ConfigFile.cc.

{
    // Remove leading and trailing whitespace
    std::string whiteSpace = " \n\t\v\r\f";
    s.erase( 0, s.find_first_not_of(whiteSpace) );
    s.erase( s.find_last_not_of(whiteSpace) + 1);
}

void lsst::meas::algorithms::shapelet::ConfigFile::write

(

std::ostream &

os

)

const

Definition at line 156 of file ConfigFile.cc.

{
    // Save a ConfigFile to os
    for(MapCIt p = _contents.begin(); p != _contents.end(); ++p ) {
        os << p->first << " " << _delimiter << " ";
        os << p->second << std::endl;
    }
}

void lsst::meas::algorithms::shapelet::ConfigFile::writeAsComment

(

std::ostream &

os

)

const

Definition at line 165 of file ConfigFile.cc.

{
    // Save a ConfigFile to os
    for(MapCIt p = _contents.begin(); p != _contents.end(); ++p ) {
        std::string f = p->first;
        std::string s = p->second;
        std::replace(f.begin(),f.end(),'\n',' ');
        std::replace(s.begin(),s.end(),'\n',' ');
        os << _comment << " " << f << " " << _delimiter << " ";
        os << s << std::endl;
    }
}

Member Data Documentation

std::string lsst::meas::algorithms::shapelet::ConfigFile::_comment

protected

Definition at line 331 of file ConfigFile.h.

std::map<std::string,ConvertibleString> lsst::meas::algorithms::shapelet::ConfigFile::_contents

protected

Definition at line 334 of file ConfigFile.h.

std::string lsst::meas::algorithms::shapelet::ConfigFile::_delimiter

protected

Definition at line 330 of file ConfigFile.h.

std::string lsst::meas::algorithms::shapelet::ConfigFile::_include

protected

Definition at line 332 of file ConfigFile.h.

std::string lsst::meas::algorithms::shapelet::ConfigFile::_sentry

protected

Definition at line 333 of file ConfigFile.h.

---

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

• /home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/include/lsst/meas/algorithms/shapelet/ConfigFile.h
• /home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/src/shapelet/ConfigFile.cc