Properties.h

/*
 *   Repast for High Performance Computing (Repast HPC)
 *
 *   Copyright (c) 2010 Argonne National Laboratory
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with
 *   or without modification, are permitted provided that the following
 *   conditions are met:
 *
 *     Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *     Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *     Neither the name of the Argonne National Laboratory nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 *  Properties.h
 *
 *  Created on: Sep 25, 2009
 *      Author: nick
 */
 
#ifndef PROPERTIES_H_
#define PROPERTIES_H_
 
#include <fstream>
 
 
#include <iostream>
#include <map>
#include <string>
 
#include <boost/iterator/transform_iterator.hpp>
#include <boost/mpi/communicator.hpp>
#include <boost/filesystem.hpp>
 
#include "logger.h"
 
#define MAX_PROP_FILE_SIZE 16384
 
namespace repast {
 
struct KeyGetter: public std::unary_function<std::map<std::string, std::string>::value_type, std::string> {
  std::string operator()(const std::map<std::string, std::string>::value_type& value) const;
};
 
class Properties {
 
private:
  std::map<std::string, std::string> map;
 
public:
 
  typedef boost::transform_iterator<KeyGetter, std::map<std::string, std::string>::const_iterator> key_iterator;
 
  Properties();
 
  Properties(const std::string& file, boost::mpi::communicator* comm = 0, int maxPropFileSize = MAX_PROP_FILE_SIZE);
 
  Properties(const std::string& file, int argc, char** argv, boost::mpi::communicator* comm = 0, int maxPropFileSize = MAX_PROP_FILE_SIZE);
 
  Properties(int argc, char** argv);
 
  virtual ~Properties() {
  }
 
  void putProperty(const std::string& key, std::string value);
 
  void putProperty(const std::string& key, long double value);
 
 
  std::string getProperty(const std::string& key) const;
 
  bool contains(const std::string& key) const;
 
  key_iterator keys_begin() const {
    return key_iterator(map.begin());
  }
 
  key_iterator keys_end() const {
    return key_iterator(map.end());
  }
 
  void readFile(const std::string& file, boost::mpi::communicator* comm = 0, int maxPropFileSize = MAX_PROP_FILE_SIZE);
 
  void processCommandLineArguments(int argc, char **argv);
 
  int size() const {
    return map.size();
  }
 
  void log(std::string logName, std::vector<std::string> *keysToWrite = 0){
    if(keysToWrite != 0){
      std::vector<std::string>::iterator iter    = keysToWrite->begin();
      std::vector<std::string>::iterator iterEnd = keysToWrite->end();
      while(iter != iterEnd){
        Log4CL::instance()->get_logger(logName).log(INFO, (*iter) + " = " + (getProperty(*iter)));
        iter++;
      }
    }
    else{
      std::map<std::string, std::string>::iterator iter    = map.begin();
      std::map<std::string, std::string>::iterator iterEnd = map.end();
      while(iter != iterEnd){
        Log4CL::instance()->get_logger(logName).log(INFO, iter->first + " = " + iter->second);
        iter++;
      }
    }
  }
 
 
  void writeToSVFile(std::string fileName, std::string separator = ",");
 
  void writeToSVFile(std::string fileName, std::vector<std::string> &keysToWrite, std::string separator = ",");
 
  bool writeToPropsFile(std::string filename, std::string header = "");
 
  bool writeToPropsFile(std::string filename, std::vector<std::string> &keysToWrite, std::string header="");
 
  std::string propsFileString(std::vector<std::string> &keysToWrite, std::string header="");
 
 
};
 
}
 
#endif /* PROPERTIES_H_ */