Class represneting a basic log message. More...

#include <logger.h>

Collaboration diagram for BlamBasicLogMessage:

Public Member Functions
std::string	GetMessageLine ()
	Generates a formatted message, ready to be written to any output or log. More...

bool	Equals (BlamBasicLogMessage other_message)
	Checks if the log message is equivalent to another log message. More...

Public Attributes
BlamBasicLogger *	logger = nullptr
	The logger that the message originated from. More...

BlamLogLevel	log_level = BlamLogLevel::None
	The message log level. More...

TerminalColor	color = TerminalColor::Reset
	The custom color to assign to the message when printing to stdout. More...

bool	has_custom_color = false
	Whether or not the message has a custom terminal color set. More...

std::string	message = ""
	The message content. More...

std::string	timestamp = ""
	The message timestamp. More...

Detailed Description

Class represneting a basic log message.

Member Function Documentation

◆ Equals()

bool BlamBasicLogMessage::Equals ( BlamBasicLogMessage other_message )

Checks if the log message is equivalent to another log message.

Parameters

other_message - The log message to compare against.

Returns: true if the message is equivalent to other_message, otherwise returns false.

◆ GetMessageLine()

std::string BlamBasicLogMessage::GetMessageLine ( )

Generates a formatted message, ready to be written to any output or log.

The message is displayed in the following format:

MM.DD.YY HH:MM:SS.MIL [LOG_LEVEL]: message

Returns: The formatted log message.

Here is the call graph for this function:

Member Data Documentation

◆ color

TerminalColor BlamBasicLogMessage::color = TerminalColor::Reset

The custom color to assign to the message when printing to stdout.

◆ has_custom_color

bool BlamBasicLogMessage::has_custom_color = false

Whether or not the message has a custom terminal color set.

◆ log_level

BlamLogLevel BlamBasicLogMessage::log_level = BlamLogLevel::None

The message log level.

◆ logger

BlamBasicLogger* BlamBasicLogMessage::logger = nullptr

The logger that the message originated from.

◆ message

std::string BlamBasicLogMessage::message = ""

The message content.

◆ timestamp

std::string BlamBasicLogMessage::timestamp = ""

The message timestamp.

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

Strings/components/interface/logger/logger.h
Strings/components/interface/logger/BlamBasicLogMessage.cpp

Public Member Functions

Public Attributes