lsst::pex::logging::FileDestination Class Reference

a LogDestination represented by a file. More...

#include <FileDestination.h>

Inheritance diagram for lsst::pex::logging::FileDestination:

Public Member Functions
virtual	~FileDestination ()
const boost::filesystem::path &	getPath () const
	FileDestination (const std::string &filepath, const boost::shared_ptr< LogFormatter > &formatter, int threshold=threshold::PASS_ALL, bool truncate=false)
	FileDestination (const char *filepath, const boost::shared_ptr< LogFormatter > &formatter, int threshold=threshold::PASS_ALL, bool truncate=false)
	FileDestination (const boost::filesystem::path &filepath, const boost::shared_ptr< LogFormatter > &formatter, int threshold=threshold::PASS_ALL, bool truncate=false)
	FileDestination (const boost::filesystem::path &filepath, bool verbose=false, int threshold=threshold::PASS_ALL, bool truncate=false)
	FileDestination (const std::string &filepath, bool verbose=false, int threshold=threshold::PASS_ALL, bool truncate=false)
	FileDestination (const char *filepath, bool verbose=false, int threshold=threshold::PASS_ALL, bool truncate=false)
Public Member Functions inherited from lsst::pex::logging::LogDestination
	LogDestination (std::ostream *strm, const boost::shared_ptr< LogFormatter > &formatter, int threshold=threshold::PASS_ALL)
	create a destination with a threshold. More...
	LogDestination (const LogDestination &that)
virtual	~LogDestination ()
LogDestination &	operator= (const LogDestination &that)
int	getThreshold () const
void	setThreshold (int threshold)
bool	write (const LogRecord &rec)

Protected Attributes
boost::filesystem::path	_path
Protected Attributes inherited from lsst::pex::logging::LogDestination
int	_threshold
std::ostream *	_strm
boost::shared_ptr< LogFormatter >	_frmtr

Detailed Description

a LogDestination represented by a file.

This class makes it easier to attach files to Logs via Python via Log.addDestination().

Definition at line 49 of file FileDestination.h.

Constructor & Destructor Documentation

lsst::pex::logging::FileDestination::FileDestination ( const std::string &  filepath, const boost::shared_ptr< LogFormatter > &  formatter, int  threshold = threshold::PASS_ALL, bool  truncate = false  )

inline

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended.

Parameters

filepath	the path to the log file to write messages to.
formatter	the LogFormatter to use to format the messages
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

Definition at line 64 of file FileDestination.h.

        : LogDestination(new std::ofstream(filepath.c_str(),
                                           truncate ? std::ios::out 
                                                    : std::ios::app), 
                         formatter, threshold),
          _path(filepath) 
    { }

lsst::pex::logging::FileDestination::FileDestination ( const char *  filepath, const boost::shared_ptr< LogFormatter > &  formatter, int  threshold = threshold::PASS_ALL, bool  truncate = false  )

inline

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended.

Parameters

filepath	the path to the log file to write messages to.
formatter	the LogFormatter to use to format the messages
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

Definition at line 74 of file FileDestination.h.

        : LogDestination(new std::ofstream(filepath,
                                           truncate ? std::ios::out 
                                                    : std::ios::app), 
                         formatter, threshold),
          _path(filepath) 
    { }

lsst::pex::logging::FileDestination::FileDestination ( const boost::filesystem::path &  filepath, const boost::shared_ptr< LogFormatter > &  formatter, int  threshold = threshold::PASS_ALL, bool  truncate = false  )

inline

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended.

Parameters

filepath	the path to the log file to write messages to.
formatter	the LogFormatter to use to format the messages
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

Definition at line 84 of file FileDestination.h.

        : LogDestination(new std::ofstream(filepath.string().c_str(),
                                           truncate ? std::ios::out 
                                                    : std::ios::app), 
                         formatter, threshold),
          _path(filepath) 
    { }

lsst::pex::logging::FileDestination::FileDestination	(	const boost::filesystem::path &	filepath,
		bool	verbose = false,
		int	threshold = threshold::PASS_ALL,
		bool	truncate = false
	)

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended. The IndentedFormatter will be used to format the messages

Parameters

filepath	the path to the log file to write messages to.
verbose	if True, make sure all properties are printed out to the destination
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended. The IndentedFormatter will be used to format the messages

Parameters

filepath	the path to the log file to write messages to.
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

Definition at line 44 of file FileDestination.cc.

    : LogDestination(new std::ofstream(filepath.string().c_str(), 
                                       truncate ? std::ios::out : std::ios::app), 
                     boost::shared_ptr<LogFormatter>(new IndentedFormatter(verbose)), 
                     threshold),
      _path(filepath) 
{ }

lsst::pex::logging::FileDestination::FileDestination	(	const std::string &	filepath,
		bool	verbose = false,
		int	threshold = threshold::PASS_ALL,
		bool	truncate = false
	)

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended. The IndentedFormatter will be used to format the messages

Parameters

filepath	the path to the log file to write messages to.
verbose	if True, make sure all properties are printed out to the destination
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended. The IndentedFormatter will be used to format the messages

Parameters

filepath	the path to the log file to write messages to.
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

Definition at line 52 of file FileDestination.cc.

    : LogDestination(new std::ofstream(filepath.c_str(), 
                                       truncate ? std::ios::out : std::ios::app), 
                     boost::shared_ptr<LogFormatter>(new IndentedFormatter(verbose)), 
                     threshold),
      _path(filepath) 
{ }

lsst::pex::logging::FileDestination::FileDestination	(	const char *	filepath,
		bool	verbose = false,
		int	threshold = threshold::PASS_ALL,
		bool	truncate = false
	)

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended. The IndentedFormatter will be used to format the messages

Parameters

filepath	the path to the log file to write messages to.
verbose	if True, make sure all properties are printed out to the destination
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

create a file destination. If the file does not exist, it will be created; otherwise, messages will be appended. The IndentedFormatter will be used to format the messages

Parameters

filepath	the path to the log file to write messages to.
threshold	the minimum volume level required to pass a message to the stream. If not provided, it would be set to 0.
truncate	if True, overwrite the previous contents; otherwise, new messages will be appended to the file.

Definition at line 60 of file FileDestination.cc.

    : LogDestination(new std::ofstream(filepath, 
                                       truncate ? std::ios::out : std::ios::app), 
                     boost::shared_ptr<LogFormatter>(new IndentedFormatter(verbose)), 
                     threshold),
      _path(filepath) 
{ }

lsst::pex::logging::FileDestination::~FileDestination ( )

virtual

Definition at line 72 of file FileDestination.cc.

                                  { 
    std::ofstream *ofstrm = dynamic_cast<std::ofstream*>(_strm);
    if (ofstrm != NULL && ofstrm->is_open()) {
        try {
            ofstrm->flush();
            ofstrm->close();
        }
        catch (...) { }
    }
    delete _strm;
}

Member Function Documentation

const boost::filesystem::path& lsst::pex::logging::FileDestination::getPath ( ) const

inline

Definition at line 120 of file FileDestination.h.

{ return _path; }

Member Data Documentation

boost::filesystem::path lsst::pex::logging::FileDestination::_path

protected

Definition at line 123 of file FileDestination.h.

---

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

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