Standard text formatting of logs for biological purposes

Collaboration diagram for Standard text formatting of logs for biological purposes:

Functions
template<typename logT , typename iosT >
iosT &	flatlogs::jsonFormat (iosT &ios, bufferPtrT &logBuffer, const std::string &eventCodeName, const uint8_t *binarySchema, const unsigned int binarySchemaLength)
	Function for generate a JSON-formatted text representation of a flatlog record.
template<typename logT , typename iosT >
iosT &	flatlogs::stdFormat (iosT &ios, bufferPtrT &logBuffer)
	Worker function that formats a log into the standard text representation.
template<typename logT , typename iosT >
iosT &	flatlogs::stdShortFormat (iosT &ios, const std::string &appName, bufferPtrT &logBuffer)
	Worker function that formats a log into the standard text representation with short timespec.
template<typename logT , typename iosT >
iosT &	flatlogs::minFormat (iosT &ios, bufferPtrT &logBuffer)
	Worker function that formats a log into the standard text representation.

Detailed Description

Function Documentation

jsonFormat()

template<typename logT , typename iosT >

iosT & flatlogs::jsonFormat	(	iosT &	ios,
		bufferPtrT &	logBuffer,
		const std::string &	eventCodeName,
		const uint8_t *	binarySchema,
		const unsigned int	binarySchemaLength
	)

Function for generate a JSON-formatted text representation of a flatlog record.

Parameters

[out]	ios	the iostream to output the log too
[in]	logBuffer	the binary log buffer to output

Definition at line 30 of file logStdFormat.hpp.

References flatlogs::logHeader::extractBasicLog(), flatlogs::timespecX::ISO8601DateTimeStrX(), flatlogs::logHeader::messageBuffer(), and flatlogs::priorityString().

minFormat()

template<typename logT , typename iosT >

iosT & flatlogs::minFormat	(	iosT &	ios,
		bufferPtrT &	logBuffer
	)

Worker function that formats a log into the standard text representation.

Parameters

[out]	ios	the iostream to output the log too
[in]	logBuffer	the binary log buffer to output

Definition at line 125 of file logStdFormat.hpp.

References flatlogs::logHeader::extractBasicLog(), flatlogs::logHeader::messageBuffer(), and flatlogs::priorityString().

stdFormat()

template<typename logT , typename iosT >

iosT & flatlogs::stdFormat	(	iosT &	ios,
		bufferPtrT &	logBuffer
	)

Worker function that formats a log into the standard text representation.

Parameters

[out]	ios	the iostream to output the log too
[in]	logBuffer	the binary log buffer to output

Definition at line 60 of file logStdFormat.hpp.

References flatlogs::logHeader::extractBasicLog(), flatlogs::timespecX::ISO8601DateTimeStrX(), flatlogs::logHeader::messageBuffer(), and flatlogs::priorityString().

stdShortFormat()

template<typename logT , typename iosT >

iosT & flatlogs::stdShortFormat	(	iosT &	ios,
		const std::string &	appName,
		bufferPtrT &	logBuffer
	)

Worker function that formats a log into the standard text representation with short timespec.

Parameters

[out]	ios	the iostream to output the log to
[in]	logBuffer	the binary log buffer to output

Definition at line 82 of file logStdFormat.hpp.

References flatlogs::logHeader::extractBasicLog(), flatlogs::logHeader::messageBuffer(), flatlogs::priorityString(), and flatlogs::timespecX::secondStrX().