LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Member Functions | List of all members
lsst::pex::logging::LogClient Class Referenceabstract

an abstract interface identifying a class that writes messages to a Log. Other classes inherit from this interface to add standard methods for setting and retrieving the log that the classs will send its log messages to. More...

#include <LogClient.h>

Inheritance diagram for lsst::pex::logging::LogClient:
lsst::pex::logging::LogClientHelper

Public Member Functions

 LogClient ()
 
virtual void setLog (const Log &log)=0
 
virtual const LoggetLog () const =0
 
virtual LoggetLog ()=0
 

Detailed Description

an abstract interface identifying a class that writes messages to a Log. Other classes inherit from this interface to add standard methods for setting and retrieving the log that the classs will send its log messages to.

Typically, a class will inherit directly from LogClientHelper, which provides the internal Log data member as a convenience. This abstract parent allows the subclass to control how/where the Log is stored.

Definition at line 49 of file LogClient.h.

Constructor & Destructor Documentation

lsst::pex::logging::LogClient::LogClient ( )
inline

initialize the LogClient interface. This constructor does nothing

Definition at line 55 of file LogClient.h.

55 { }

Member Function Documentation

virtual const Log& lsst::pex::logging::LogClient::getLog ( ) const
pure virtual

return the Log being written to by this class.

virtual Log& lsst::pex::logging::LogClient::getLog ( )
pure virtual

return the Log being written to by this class.

virtual void lsst::pex::logging::LogClient::setLog ( const Log log)
pure virtual

set the Log that should be used by this class


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