lsst::pex::logging::LogRec Class Reference

A LogRecord attached to a particular Log that suppports stream stream semantics. More...

#include <Log.h>

Inheritance diagram for lsst::pex::logging::LogRec:

Public Types
enum	Manip { endr }

Public Member Functions
	LogRec (Log &log, int importance)
	LogRec (const LogRec &that)
virtual	~LogRec ()
LogRec &	operator= (const LogRec &that)
LogRec &	operator<< (const std::string &comment)
LogRec &	operator<< (const boost::format &comment)
template<class T >
LogRec &	operator<< (const RecordProperty< T > &prop)
LogRec &	operator<< (const lsst::daf::base::PropertySet &props)
LogRec &	operator<< (Manip signal)
Public Member Functions inherited from lsst::pex::logging::LogRecord
	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)
virtual	~LogRecord ()
LogRecord &	operator= (const LogRecord &that)
void	addComment (const std::string &comment)
void	addComment (const boost::format &comment)
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)
const lsst::daf::base::PropertySet &	getProperties () const
lsst::daf::base::PropertySet &	getProperties ()
const lsst::daf::base::PropertySet &	data () const
lsst::daf::base::PropertySet &	data ()
size_t	countParamNames ()
size_t	countParamValues () const
int	getImportance () const
bool	willRecord () const
bool	willShowAll () const
void	setShowAll (bool yesno)
void	setTimestamp ()
virtual void	setDate ()

Private Attributes
bool	_sent
Log *	_log

Additional Inherited Members
Static Public Member Functions inherited from lsst::pex::logging::LogRecord
static long long	utcnow ()
Protected Member Functions inherited from lsst::pex::logging::LogRecord
	LogRecord ()
void	_init ()
Protected Attributes inherited from lsst::pex::logging::LogRecord
bool	_send
bool	_showAll
int	_vol
lsst::daf::base::PropertySet::Ptr	_data

Detailed Description

A LogRecord attached to a particular Log that suppports stream stream semantics.

Definition at line 729 of file Log.h.

Member Enumeration Documentation

enum lsst::pex::logging::LogRec::Manip

Record manipulators. These values may be sent to this LogRec via the output operator to request a particular manipulation of the message.

Enumerator
endr	a manipulator indicating that the message is complete and should be sent to the Log.

Definition at line 769 of file Log.h.

               { 
        endr 
    };

Constructor & Destructor Documentation

lsst::pex::logging::LogRec::LogRec ( Log &  log, int  importance  )

inline

Create a log record to be sent to a given log.

Parameters

log	the log this record should be written to
importance	the urgency of the record. If this value is greater than or equal to the Log's importance threshold, the message will be recorded.

Definition at line 739 of file Log.h.

        : LogRecord(log.getThreshold(), importance, log.getPreamble()), 
          _sent(false), _log(&log)
    { }

lsst::pex::logging::LogRec::LogRec ( const LogRec &  that )

inline

create a copy

Definition at line 747 of file Log.h.

        : LogRecord(that), _sent(false), _log(that._log) 
    { }

virtual lsst::pex::logging::LogRec::~LogRec ( )

virtual

delete this record

Member Function Documentation

LogRec& lsst::pex::logging::LogRec::operator<<

(

const std::string &

comment

)

record a string comment into this message

LogRec& lsst::pex::logging::LogRec::operator<< ( const boost::format &  comment )

inline

record a string comment into this message

Definition at line 788 of file Log.h.

                                                   {
        addComment(comment);
        return *this;
    }

template<class T >

LogRec& lsst::pex::logging::LogRec::operator<< ( const RecordProperty< T > &  prop )

inline

record a data property into this message

Definition at line 797 of file Log.h.

                                                      {
        addProperty(prop.name, prop.value);
        return *this;
    }

LogRec& lsst::pex::logging::LogRec::operator<< ( const lsst::daf::base::PropertySet &  props )

inline

record a data property into this message

Definition at line 805 of file Log.h.

                                                            {
        addProperties(props);
        return *this;
    }

LogRec& lsst::pex::logging::LogRec::operator<< ( Manip  signal )

inline

receive a message manipulator signal. The most common use of this version is to indicate that the Record is now complete and should be flushed to the Log.

Parameters

signal

the manipulator signal value (e.g. LogRec::endr).

Definition at line 816 of file Log.h.

                                     {
        if (_send) {
            switch (signal) {
            case endr:
                _log->send(*this);
                _sent = true;
                break;
            default:
                ;
            }
        }
        return *this;
    }

LogRec& lsst::pex::logging::LogRec::operator= ( const LogRec &  that )

inline

copy another record into this one

Definition at line 759 of file Log.h.

                                          {
        LogRecord::operator=(that);
        _log = that._log;
        return *this;
    }

Member Data Documentation

Log* lsst::pex::logging::LogRec::_log

private

Definition at line 832 of file Log.h.

bool lsst::pex::logging::LogRec::_sent

private

Definition at line 831 of file Log.h.

---

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

• /home/lsstsw/stack/Linux64/pex_logging/11.0.rc2+6/include/lsst/pex/logging/Log.h