LogRecord.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_PEX_LOGRECORD_H
#define LSST_PEX_LOGRECORD_H

#include "lsst/daf/base/PropertySet.h"

#include <boost/shared_ptr.hpp>
#include <boost/format.hpp>
#include <string>
#include <sys/time.h>

#define LSST_LP_COMMENT     "COMMENT"
#define LSST_LP_TIMESTAMP   "TIMESTAMP"
#define LSST_LP_DATE        "DATE"
#define LSST_LP_LOG         "LOG"
#define LSST_LP_LEVEL       "LEVEL"

namespace lsst {
namespace pex {
namespace logging {

template <class T>
class RecordProperty {
public:
    typedef T ValueType;

    RecordProperty(const std::string& pname, const T& pvalue) 
        : name(pname), value(pvalue) { }

    void addTo(lsst::daf::base::PropertySet& set) { set.add(this->name, this->value); }

    const std::string name;
    const T& value;
};

/*
 * a shorthand version of the RecordProperty class
 */
template <class T>
class Prop : public RecordProperty<T> { 
public:
    Prop(const std::string& pname, const T& value) 
        : RecordProperty<T>(pname, value) { }
};

class LogRecord {
public:

    LogRecord(int threshold, int importance, bool showAll=false);

    LogRecord(int threshold, int importance, 
              const lsst::daf::base::PropertySet& preamble, bool showAll=false);

    LogRecord(const LogRecord& that) 
        : _send(that._send), _showAll(that._showAll), _vol(that._vol), _data()
    { 
        _data = that._data->deepCopy();
    }   

    virtual ~LogRecord();

    LogRecord& operator=(const LogRecord& that) {
        _send = that._send; 
        _showAll = that._showAll; 
        _vol = that._vol; 
        _data = that._data;
        return *this;
    }

    void addComment(const std::string& comment) {
        if (_send) _data->add(LSST_LP_COMMENT, comment);
    }

    void addComment(const boost::format& comment) {
        if (_send) addComment(comment.str());
    }

    template <class T>
    void addProperty(const RecordProperty<T>& property);

    template <class T>
    void addProperty(const std::string& name, const T& val);

    void addProperties(const lsst::daf::base::PropertySet& props);

    void addProperties(const lsst::daf::base::PropertySet::Ptr& props) {
        addProperties(*props);
    }

    const lsst::daf::base::PropertySet& getProperties() const { return data(); }

    lsst::daf::base::PropertySet& getProperties() { return data(); }

    const lsst::daf::base::PropertySet& data() const { return *_data; }

    lsst::daf::base::PropertySet& data() { return *_data; }

    size_t countParamNames() {
        std::vector<std::string> names = data().paramNames(false);
        return names.size();
    }

    size_t countParamValues() const;

    int getImportance() const { return _vol; }

    bool willRecord() const { return _send; }

    bool willShowAll() const { return _showAll; } 

    void setShowAll(bool yesno) {  _showAll = yesno;  }

    void setTimestamp();

    virtual void setDate();

    static long long utcnow();

protected: 
    LogRecord() : _send(false), _vol(10), _data(new lsst::daf::base::PropertySet()) { }

    void _init() {
        if (_send) {
            _data->set("LEVEL", _vol);
            setDate();
        }
    }

    bool _send;    // true if this record should be sent to the log
    bool _showAll; // true if there is preference to have all data displayed
    int _vol;      // the importance volume of this message
    lsst::daf::base::PropertySet::Ptr _data;
};

template <class T>
void LogRecord::addProperty(const RecordProperty<T>& property) {
    if (_send) property.addTo(_data);
}

template <class T>
void LogRecord::addProperty(const std::string& name, const T& val) {
    if (_send) data().add(name, val);
}



}}} // end lsst::pex::logging

#endif // end LSST_PEX_LOGRECORD_H