LogDestination.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_LOGDESTINATION_H
#define LSST_PEX_LOGDESTINATION_H

#include "lsst/pex/logging/LogFormatter.h"
#include "lsst/pex/logging/threshold/enum.h"

#include <string>
#include <ostream>
#include <boost/shared_ptr.hpp>

namespace lsst {
namespace pex {
namespace logging {

// forward declaration of LogRecord
class LogRecord;

class LogDestination {
public:

    LogDestination(std::ostream *strm, 
                   const boost::shared_ptr<LogFormatter>& formatter, 
                   int threshold=threshold::PASS_ALL);

    LogDestination(const LogDestination& that);

    virtual ~LogDestination();

    LogDestination& operator=(const LogDestination& that);

    int getThreshold() const { return _threshold; }

    void setThreshold(int threshold) { _threshold = threshold; }

    bool write(const LogRecord& rec);

protected:
    int _threshold;   // the stream's threshold
    std::ostream *_strm;   // the output stream
    boost::shared_ptr<LogFormatter> _frmtr;    // the formatter to use
};

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

#endif  // LSST_PEX_LOGDESTINATION_H