LibPkg
Public Member Functions | List of all members
pkg::log_entry Class Reference

A class to represent one log entry. More...

#include <log.h>

Public Member Functions

 log_entry ()
 Construct uninitialised log entry. More...
 
 log_entry (const log_entry &other)
 Copy constructor. More...
 
 ~log_entry ()
 Destroy entry freeing memory. More...
 
log_entryoperator= (const log_entry &other)
 Assignment. More...
 
 log_entry (LogCode code, const char *param1=0, const char *param2=0)
 Construct log entry. More...
 
int code () const
 Log entry error code. More...
 
int type () const
 Log entry type. More...
 
int sub_code () const
 Log entry sub code. More...
 
int when () const
 Time since midnight of log entry. More...
 
std::string when_text () const
 Time of log entry as text. More...
 
std::string text () const
 Description of this log entry. More...
 

Detailed Description

A class to represent one log entry.

Constructor & Destructor Documentation

◆ log_entry() [1/3]

pkg::log_entry::log_entry ( )

Construct uninitialised log entry.

◆ log_entry() [2/3]

pkg::log_entry::log_entry ( const log_entry other)

Copy constructor.

References pkg::copystr().

◆ ~log_entry()

pkg::log_entry::~log_entry ( )

Destroy entry freeing memory.

◆ log_entry() [3/3]

pkg::log_entry::log_entry ( LogCode  code,
const char *  param1 = 0,
const char *  param2 = 0 
)

Construct log entry.

Parameters
codeEntry log code
param1first parameter or 0 (the default) for none
param2second parameter or 0 (the default) for none

References code(), and pkg::copystr().

Member Function Documentation

◆ operator=()

log_entry & pkg::log_entry::operator= ( const log_entry other)

Assignment.

References pkg::copystr().

◆ code()

int pkg::log_entry::code ( ) const
inline

Log entry error code.

Returns
error code

Referenced by pkg::log::bad(), and log_entry().

◆ type()

int pkg::log_entry::type ( ) const
inline

Log entry type.

Returns
type 0-error, 1-warning, 2-trace, 3-information

Referenced by text().

◆ sub_code()

int pkg::log_entry::sub_code ( ) const
inline

Log entry sub code.

Returns
sub code within all codes for the type

Referenced by text().

◆ when()

int pkg::log_entry::when ( ) const
inline

Time since midnight of log entry.

The time in the logs will wrap every day

References text(), and when_text().

◆ when_text()

std::string pkg::log_entry::when_text ( ) const

Time of log entry as text.

Returns
time of log entry in format HH:MM:SS

Referenced by when().

◆ text()

std::string pkg::log_entry::text ( ) const

Description of this log entry.

Returns
text for this log entry

References pkg::log_text, sub_code(), pkg::log_text_item::text, and type().

Referenced by when().


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

Reference Manual LibPkg Version 0.6.1 (28 Jan 2015)