---

Qmms::Log::LayoutAppender Class Reference

Base class for Appenders that require a Layout. More...

#include <log.hh>

Inheritance diagram for Qmms::Log::LayoutAppender::

List of all members.

Public Methods
	LayoutAppender ()
	Default constructor does nothing. More...
	LayoutAppender (const QString &name)
	Constructor pushes name to base class. More...
	LayoutAppender (const QString &name, Layout *lyt)
	Full constructor. More...
virtual	~LayoutAppender ()
	Destructor deletes the layout. More...
void	setLayout (Layout *lyt)
	Accessor method. More...
Layout *	getLayout ()
	Accessor method. More...
bool	requiresLayout () const
	Indicates whether this Appender requires a Layout. More...
virtual bool	checkEntryConditions () const
	Checks whether this Appender is ready to append LoggingEvents. More...
virtual void	append (LoggingEvent *evnt)
	Logs the LoggingEvent, after checking entry conditions, by passing event to subAppend(). More...
virtual void	subAppend (LoggingEvent *evnt)=0
	Pure virtual method. More...
Protected Attributes
Layout *	layout
	The layout. More...

---

Detailed Description

Base class for Appenders that require a Layout.

---

Constructor & Destructor Documentation

Qmms::Log::LayoutAppender::LayoutAppender (    )

Default constructor does nothing.

Qmms::Log::LayoutAppender::LayoutAppender (  const QString &    name )

Constructor pushes name to base class. Layout must be set explicitly. Parameters: name  the name of this Appender

Qmms::Log::LayoutAppender::LayoutAppender (  const QString &    name, Layout *    lyt )

Full constructor. Layout is set. Parameters: name  the name of the Appender lyt  pointer to the Layout to use

virtual Qmms::Log::LayoutAppender::~LayoutAppender (    )  [virtual]

Destructor deletes the layout.

---

Member Function Documentation

virtual void Qmms::Log::LayoutAppender::append (  LoggingEvent *    evnt )  [virtual]

Logs the LoggingEvent, after checking entry conditions, by passing event to subAppend(). May be subclassed. Parameters: evnt  the LoggingEvent to log Reimplemented from Qmms::Log::AppenderSkeleton.

virtual bool Qmms::Log::LayoutAppender::checkEntryConditions (    )  const [virtual]

Checks whether this Appender is ready to append LoggingEvents. For LayoutAppenders, this means checking that a Layout does in fact exist. Returns: true if yes, false otherwise Reimplemented from Qmms::Log::AppenderSkeleton. Reimplemented in Qmms::Log::StreamAppender.

Layout* Qmms::Log::LayoutAppender::getLayout (    )

Accessor method. Returns: pointer to the Layout used in this Appender

bool Qmms::Log::LayoutAppender::requiresLayout (    )  const [virtual]

Indicates whether this Appender requires a Layout. It does. Returns: true Reimplemented from Qmms::Log::AppenderSkeleton. Reimplemented in Qmms::Log::StreamAppender.

void Qmms::Log::LayoutAppender::setLayout (  Layout *    lyt )

Accessor method. Sets the Layout for this Appender. Parameters: lyt  pointer to the Layout to use

virtual void Qmms::Log::LayoutAppender::subAppend (  LoggingEvent *    evnt )  [pure virtual]

Pure virtual method. Subclasses implement this method to append events in an appender-specific manner. Parameters: evnt  the LoggingEvent to log Reimplemented in Qmms::Log::TextEditAppender, Qmms::Log::StreamAppender, Qmms::Log::FileAppender, Qmms::Log::RollingFileAppender, and Qmms::Log::SyslogAppender.

---

Member Data Documentation

Layout* Qmms::Log::LayoutAppender::layout [protected]

The layout. Reimplemented in Qmms::Log::SyslogAppender.

---

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

• log.hh

---