HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
UT_UniversalLogSink Class Referenceabstract

#include <UT_UniversalLogSink.h>

+ Inheritance diagram for UT_UniversalLogSink:

Public Types

using LogEntryFilterCallback = UT_Function< bool(const UT_UniversalLogEntry &)>
 

Public Member Functions

 UT_UniversalLogSink ()
 
virtual ~UT_UniversalLogSink ()
 
void connect (const UT_StringHolder &source_name)
 
void disconnect (const UT_StringHolder &source_name)
 
void disconnectAll ()
 
void getConnectedSourceNames (UT_StringArray &source_names)
 
void setFilterEntryCallback (const LogEntryFilterCallback &callback)
 
void log (const UT_UniversalLogEntry &entry)
 Record a message from a log source. More...
 

Protected Member Functions

virtual void doLog (const UT_UniversalLogEntry &entry)=0
 

Detailed Description

This class exists to amalgamate logging information from a variety of sources (UT_UniversalLogSource objects). Log entries can be fetched and filtered to present the user with just the logging they are interested in.

Definition at line 27 of file UT_UniversalLogSink.h.

Member Typedef Documentation

using UT_UniversalLogSink::LogEntryFilterCallback = UT_Function<bool( const UT_UniversalLogEntry&)>

Definition at line 31 of file UT_UniversalLogSink.h.

Constructor & Destructor Documentation

UT_UniversalLogSink::UT_UniversalLogSink ( )
virtual UT_UniversalLogSink::~UT_UniversalLogSink ( )
virtual

Member Function Documentation

void UT_UniversalLogSink::connect ( const UT_StringHolder &  source_name)

Each sink creates its own source objects, and can only have one source of any given type.

void UT_UniversalLogSink::disconnect ( const UT_StringHolder &  source_name)
void UT_UniversalLogSink::disconnectAll ( )
virtual void UT_UniversalLogSink::doLog ( const UT_UniversalLogEntry &  entry)
protectedpure virtual

Implemented in UT_UniversalLogInMemorySink, and UT_UniversalLogFileLikeSink.

void UT_UniversalLogSink::getConnectedSourceNames ( UT_StringArray &  source_names)
void UT_UniversalLogSink::log ( const UT_UniversalLogEntry &  entry)

Record a message from a log source.

void UT_UniversalLogSink::setFilterEntryCallback ( const LogEntryFilterCallback &  callback)
inline

Definition at line 43 of file UT_UniversalLogSink.h.

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