Model Railroad System  2.2.1
Public Types | Public Member Functions | List of all members
FCFSupport::LogMessageCallback Class Reference

A callback to log a message. More...

#include <CallBack.h>

Public Types

enum  MessageType { Infomational =1, Warning =2, Error =3 }
 The three types of messages. More...
 

Public Member Functions

 LogMessageCallback ()
 Constructor. More...
 
virtual ~LogMessageCallback ()
 Destructor. More...
 
virtual void LogMessage (MessageType Type, const string Message) const
 Log message callback function. More...
 

Detailed Description

A callback to log a message.

This callback class is used to display various sorts of messages in an application dependent way. There are three types of messages, informational messages, warning messages, and error messages. Infomational messages are just to inform the user of of important things that are happening. Warning messages are to inform the user of minor, correctable, problems. Error are to inform the user of serious problems that need to be fixed before proceding much further.

@author Robert Heller \<heller\@deepsoft.com\>

Member Enumeration Documentation

◆ MessageType

The three types of messages.

Enumerator
Infomational 

Random informational messages.

Warning 

Warning messages.

Error 

Error messages.

Constructor & Destructor Documentation

◆ LogMessageCallback()

FCFSupport::LogMessageCallback::LogMessageCallback ( )
inline

Constructor.

The base constructor does nothing. It is presumed that a derived class might do something useful.

◆ ~LogMessageCallback()

virtual FCFSupport::LogMessageCallback::~LogMessageCallback ( )
inlinevirtual

Destructor.

The base destructor does nothing. It is presumed that a derived class might do something useful.

Member Function Documentation

◆ LogMessage()

virtual void FCFSupport::LogMessageCallback::LogMessage ( MessageType  Type,
const string  Message 
) const
inlinevirtual

Log message callback function.

Display a specific type of message in an application specific way.

Parameters
TypeThe message type.
MessageThe message itself.