ara::log::LoggingFramework Class Reference

Logging framework which links loggers to a log sink. More...

#include <logging_framework.h>

Public Member Functions
const Logger &	CreateLogger (std::string ctxId, std::string ctxDescription)
	Create a logger. More...
const Logger &	CreateLogger (std::string ctxId, std::string ctxDescription, LogLevel ctxDefLogLevel)
	Create a logger. More...
void	Log (const Logger &logger, LogLevel logLevel, const LogStream &logStream)
	Log a stream to the determined sink. More...

Static Public Member Functions
static LoggingFramework *	Create (std::string appId, LogMode logMode, LogLevel logLevel=LogLevel::kWarn, std::string appDescription="")
	Logging framework factory. More...
static LoggingFramework *	Create (std::string appId, std::string filePath, LogLevel logLevel=LogLevel::kWarn, std::string appDescription="")
	Logging framework factory only for file sinks. More...

Detailed Description

Logging framework which links loggers to a log sink.

Member Function Documentation

Create() [1/2]

LoggingFramework * ara::log::LoggingFramework::Create ( std::string  appId, LogMode  logMode, LogLevel  logLevel = LogLevel::kWarn, std::string  appDescription = ""  )

static

Logging framework factory.

Parameters

appId	Application ID
logMode	Log sink mode
logLevel	Log severity level
appDescription	Application description

Returns

Pointer to created logging framework

Exceptions

std::invalid_argument

Throws when file log mode is chosen

Note

To create a framework to use a file sink refer to see aslo

See also

Create(std::string, std::string, LogLevel, std::string)

Create() [2/2]

LoggingFramework * ara::log::LoggingFramework::Create ( std::string  appId, std::string  filePath, LogLevel  logLevel = LogLevel::kWarn, std::string  appDescription = ""  )

static

Logging framework factory only for file sinks.

Parameters

appId	Application ID
filePath	Log file path
logLevel	Log severity level
appDescription	Application description

Returns

Pointer to created logging framework

Note

To create a framework for other sinks refer to see also

See also

Create(std::string, LogMode, LogLevel, std::string)

CreateLogger() [1/2]

const Logger & ara::log::LoggingFramework::CreateLogger	(	std::string	ctxId,
		std::string	ctxDescription
	)

Create a logger.

Parameters

ctxId	Log context ID
ctxDescription	Log context description

Returns

A logger

CreateLogger() [2/2]

const Logger & ara::log::LoggingFramework::CreateLogger	(	std::string	ctxId,
		std::string	ctxDescription,
		LogLevel	ctxDefLogLevel
	)

Create a logger.

Parameters

ctxId	Log context ID
ctxDescription	Log context description
ctxDefLogLevel	Log context default log level

Returns

A logger

Log()

void ara::log::LoggingFramework::Log	(	const Logger &	logger,
		LogLevel	logLevel,
		const LogStream &	logStream
	)

Log a stream to the determined sink.

Parameters

logger	A logger
logLevel	Log severity level
logStream	Stream to be logged