ldas-tools  2.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
GenericAPI::Log::HTML Class Reference

HTML Logging class. More...

#include <LogHTML.hh>

Inheritance diagram for GenericAPI::Log::HTML:
GenericAPI::Log::LDAS LDASTools::AL::Log

Public Types

enum  message_type {
  MT_OK = 0, MT_WARN = 1, MT_ERROR = 2, MT_EMAIL = 3,
  MT_PHONE = 4, MT_DEBUG = 5, MT_NOTE = 6, MT_ORANGE,
  MT_CERTMAIL, MT_GREEN = MT_OK, MT_YELLOW = MT_WARN, MT_RED = MT_ERROR,
  MT_MAIL = MT_EMAIL, MT_PAGER = MT_PHONE, MT_BLUE = MT_DEBUG, MT_PURPLE = MT_NOTE
}
 Types of messages. More...
 
enum  time_format { TF_GMT, TF_LOCAL }
 
typedef int group_type
 
typedef
LDASTools::AL::SharedPtr
< StreamInterface
stream_type
 
typedef int level_type
 

Public Member Functions

 HTML (const std::string &BaseName)
 Constructor. More...
 
virtual HTMLClone (const std::string &BaseName) const
 Create a new instance. More...
 
virtual const char * FileExtension () const
 
virtual std::string FormatJobInfo (const std::string &JobInfo) const
 
virtual void Message (message_type MessageType, level_type Level, const std::string &Caller, const std::string &JobInfo, const std::string &Message)
 
void Message (const group_type Group, const level_type Level, const std::string &Message)
 
void Stream (stream_type Output)
 
void Verbosity (const group_type Group, const level_type Level)
 
bool VerbosityCheck (const group_type Group, const level_type Level) const
 
void EntriesMax (int Value)
 

Static Public Member Functions

static std::string FormatTime (time_format Format, const LDASTools::AL::GPSTime &Time)
 
static std::string LogFilename (const char *Extension, int Version)
 

Protected Member Functions

virtual void header ()
 
virtual void footer ()
 
virtual void onStreamClose ()
 
virtual void onStreamOpen ()
 
void writeDirect (const std::string &Message)
 Send a message immediately to the logging stream. More...
 
void purge ()
 

Static Protected Member Functions

static std::string siteInfoLookup (const std::string &LDASSystemName)
 

Protected Attributes

stream_type m_stream
 

Detailed Description

HTML Logging class.

Member Enumeration Documentation

Types of messages.

Enumerator
MT_OK 

Nornal status.

MT_WARN 

Notable condition which is a non-fatal error.

MT_ERROR 

Fatal error condition.

MT_EMAIL 

Condition which requires operator intervention.

MT_PHONE 

Condition which requires immediate operator intervention.

MT_DEBUG 

Debugging message intended for developers.

MT_NOTE 

Notable condition which is not an error.

MT_ORANGE 

Error condition not fatal to the job.

MT_CERTMAIL 

Condition which requires operator intervention.

MT_GREEN 

Alias for MT_OK.

MT_YELLOW 

Alias for MT_WARN.

MT_RED 

Alias for MT_ERROR.

MT_MAIL 

Alias for MT_EMAIL.

MT_PAGER 

Alias for MT_PHONE.

MT_BLUE 

Alias for MT_DEBUG.

MT_PURPLE 

Alias for MT_NOTE.

Enumerator
TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

Constructor & Destructor Documentation

GenericAPI::Log::HTML::HTML ( const std::string &  BaseName)

Constructor.

Parameters
[in]BaseNameThe base name to be used for creation of the log file.
Returns
An instance of this object.

Member Function Documentation

virtual HTML* GenericAPI::Log::HTML::Clone ( const std::string &  BaseName) const
virtual

Create a new instance.

Returns
A new instance of this object

Implements GenericAPI::Log::LDAS.

virtual const char* GenericAPI::Log::HTML::FileExtension ( ) const
virtual

Implements GenericAPI::Log::LDAS.

virtual void GenericAPI::Log::LDAS::footer ( )
protectedvirtualinherited

Reimplemented in GenericAPI::Log::Text.

virtual std::string GenericAPI::Log::HTML::FormatJobInfo ( const std::string &  JobInfo) const
virtual

Implements GenericAPI::Log::LDAS.

static std::string GenericAPI::Log::LDAS::FormatTime ( time_format  Format,
const LDASTools::AL::GPSTime Time 
)
staticinherited
virtual void GenericAPI::Log::LDAS::header ( )
protectedvirtualinherited

Reimplemented in GenericAPI::Log::Text.

static std::string GenericAPI::Log::LDAS::LogFilename ( const char *  Extension,
int  Version 
)
staticinherited
virtual void GenericAPI::Log::HTML::Message ( message_type  MessageType,
level_type  Level,
const std::string &  Caller,
const std::string &  JobInfo,
const std::string &  Message 
)
virtual

Implements GenericAPI::Log::LDAS.

virtual void GenericAPI::Log::LDAS::onStreamClose ( )
protectedvirtualinherited

Reimplemented from LDASTools::AL::Log.

virtual void GenericAPI::Log::LDAS::onStreamOpen ( )
protectedvirtualinherited

Reimplemented from LDASTools::AL::Log.

static std::string GenericAPI::Log::LDAS::siteInfoLookup ( const std::string &  LDASSystemName)
staticprotectedinherited
void GenericAPI::Log::LDAS::writeDirect ( const std::string &  Message)
inlineprotectedinherited

Send a message immediately to the logging stream.


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