Yate
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Friends
CapturedEvent Class Reference

A captured event string with a debug level. More...

#include <yateclass.h>

Inheritance diagram for CapturedEvent:
String GenObject

List of all members.

Public Member Functions

 CapturedEvent (int level, const char *text)
 CapturedEvent (const CapturedEvent &original)
int level () const

Static Public Member Functions

static bool capturing ()
static const ObjListevents ()
static void append (int level, const char *text)

Static Protected Member Functions

static ObjListeventsRw ()
static void capturing (bool capture)

Friends

class Engine

Detailed Description

A captured event string with a debug level.

Holder for an event (output, debug or alarm) message


Constructor & Destructor Documentation

CapturedEvent ( int  level,
const char *  text 
) [inline]

Constructor

Parameters:
levelDebugging level associated with the event
textText description of the event
CapturedEvent ( const CapturedEvent original) [inline]

Copy constructor

Parameters:
originalCaptured event to copy

Member Function Documentation

static void append ( int  level,
const char *  text 
) [inline, static]

Add an event to the captured events list

Parameters:
levelDebugging level associated with the event
textText description of the event, must not be empty

References ObjList::append().

static bool capturing ( ) [inline, static]

Get the capturing state of the output and debug messages

Returns:
True if output and debug messages are being captured
static void capturing ( bool  capture) [inline, static, protected]

Enable or disable capturing of output and debug messages

Parameters:
captureTrue to capture internally the debugging messages
static const ObjList& events ( ) [inline, static]

Get the list of captured events

Returns:
List of events captured from output and debugging
static ObjList& eventsRw ( ) [inline, static, protected]

Get a writable list of captured events

Returns:
List of events captured from output and debugging
int level ( ) const [inline]

Get the debugging level of the event

Returns:
Debugging level associated with the event

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