HydraExpress™ C++ API Reference Guide

 
Loading...
Searching...
No Matches
rwsf::LogMessage Class Reference

Constructs log messages, provides insertion operators for basic types, and can be extended to support user-defined types as well. More...

#include <rwsf/core/LogMessage.h>

Public Member Functions

 LogMessage ()
void append (const std::string &str)
virtual std::string str () const

(Note that these are not member symbols.)

rwsf::LogMessageoperator<< (rwsf::LogMessage &, bool)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, char)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, const char *)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, const std::string &)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, double)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, float)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, int)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, long)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, short)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, unsigned char)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, unsigned int)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, unsigned long)
rwsf::LogMessageoperator<< (rwsf::LogMessage &, unsigned short)

Detailed Description

rwsf::LogMessage is a utility class for constructing log messages. LogMessage provides insertion operators for basic types, and can be extended to support user-defined types as well.

Note
For more information on the Agent logger, see the logging chapter in the User Guide.

The following example demonstrates how to create a simple message and insert a basic data type:

int logType = 0;
rwsf::Logger logger = rwsf::LogManager()::getLogger();
msg << "This is a " << logType << "-type logger.";
msg.append("\n");
logger.info(msg);
Provides a central point for accessing logger instances.
Definition LogManager.h:90
Constructs log messages, provides insertion operators for basic types, and can be extended to support...
Definition LogMessage.h:45
void append(const std::string &str)
Provides an interface for writing log messages to the logging framework.
Definition Logger.h:58
void info(const std::string &message)

Constructor & Destructor Documentation

◆ LogMessage()

rwsf::LogMessage::LogMessage ( )

Default constructor. Creates a blank message.

Member Function Documentation

◆ append()

void rwsf::LogMessage::append ( const std::string & str)

Appends text to the log message.

◆ str()

virtual std::string rwsf::LogMessage::str ( ) const
virtual

Returns the prepared message as a string.

◆ operator<<() [1/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
bool  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [2/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
char  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [3/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
const char *  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [4/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
const std::string &  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [5/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
double  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [6/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
float  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [7/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
int  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [8/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
long  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [9/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
short  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [10/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
unsigned char  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [11/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
unsigned int  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [12/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
unsigned long  )
related

Insertion operator for appending to a LogMessage instance.

◆ operator<<() [13/13]

rwsf::LogMessage & operator<< ( rwsf::LogMessage & ,
unsigned short  )
related

Insertion operator for appending to a LogMessage instance.

Copyright © 2026 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.