QCanServerLogger Class Reference

Detailed Description

This class add a logging capability for a QCanServer.

Todo

• Description of file names, default log level

#include <qcan_server_logger.hpp>

Inheritance diagram for QCanServerLogger:

Public Slots
virtual void	appendMessage (const QCan::CAN_Channel_e teChannelV, const QString &clLogMessageV, const QCan::LogLevel_e teLogLevelV=QCan::eLOG_LEVEL_INFO)

Public Member Functions
	QCanServerLogger (QCanServer *pclServerV=nullptr)
void	attachServer (QCanServer *pclServerV)
QCan::LogLevel_e	logLevel (const QCan::CAN_Channel_e teChannelV) const
QString	message (void) const
bool	setFileName (const QCan::CAN_Channel_e teChannelV, const QString clFileNameV)
void	setLogLevel (const QCan::CAN_Channel_e teChannelV, const QCan::LogLevel_e teLogLevelV)

Constructor & Destructor Documentation

QCanServerLogger()

QCanServerLogger::QCanServerLogger

(

QCanServer *

pclServerV = nullptr

)

Parameters

[in]

pclServerV

- Pointer to QCanServer class

Create new QCanServerLogger object. The parameter pclServerV defines the QCanServer which shall be attached for logging.

Member Function Documentation

appendMessage

virtual void QCanServerLogger::appendMessage ( const QCan::CAN_Channel_e teChannelV, const QString & clLogMessageV, const QCan::LogLevel_e teLogLevelV = QCan::eLOG_LEVEL_INFO )

virtualslot

Parameters

[in]	teChannelV	- CAN channel
[in]	clLogMessageV	- Log message
[in]	teLogLevelV	- Log level

The function appends a log message to the log file. The message will be prepended with a time stamp. The parameter teLogLevelV defines the log level of the message. Only messages with a log level smaller or equal to the actual defined log level will be appended (see setLogLevel()).

attachServer()

void QCanServerLogger::attachServer

(

QCanServer *

pclServerV

)

Parameters

[in]

pclServerV

- Pointer to QCanServer class

The function attaches a QCanServer instance for logging.

logLevel()

QCan::LogLevel_e QCanServerLogger::logLevel

(

const QCan::CAN_Channel_e

teChannelV

)

const

Parameters

[in]

teChannelV

- CAN channel

Returns

Current log level

See also

setLogLevel()

The function changes the default file path and file name for the log attached to the CAN channel defined by the parameter teChannelV.

message()

QString QCanServerLogger::message ( void ) const

inline

Returns

Generated log message

See also

appendMessage()

The function returns the log message generated by appendMessage(), including the time stamp.

setFileName()

bool QCanServerLogger::setFileName	(	const QCan::CAN_Channel_e	teChannelV,
		const QString	clFileNameV )

Parameters

[in]	teChannelV	- CAN channel
[in]	clFileNameV	- Log file name

Returns

true if file could be opened, otherwise false

The function changes the default file path and file name for the log attached to the CAN channel defined by the parameter teChannelV.

setLogLevel()

void QCanServerLogger::setLogLevel	(	const QCan::CAN_Channel_e	teChannelV,
		const QCan::LogLevel_e	teLogLevelV )

Parameters

[in]	teChannelV	- CAN channel
[in]	teLogLevelV	- Log level

See also

logLevel()

The function changes the default log level for the CAN channel defined by the parameter teChannelV. The new log level will be appended to the log file.