ldas-tools-ldasgen  2.6.1
 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 | List of all members
GenericAPI::Log::Text Class Reference

Text Logging class. More...

#include <LogText.hh>

Inheritance diagram for GenericAPI::Log::Text:
GenericAPI::Log::LDAS

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 }
 

Public Member Functions

 Text (const std::string &BaseName)
 Constructor. More...
 
virtual TextClone (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)
 

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...
 

Static Protected Member Functions

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

Detailed Description

Text 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::Text::Text ( 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 Text* GenericAPI::Log::Text::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::Text::FileExtension ( ) const
virtual

Implements GenericAPI::Log::LDAS.

virtual void GenericAPI::Log::Text::footer ( )
protectedvirtual

Reimplemented from GenericAPI::Log::LDAS.

virtual std::string GenericAPI::Log::Text::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::Text::header ( )
protectedvirtual

Reimplemented from GenericAPI::Log::LDAS.

static std::string GenericAPI::Log::LDAS::LogFilename ( const char *  Extension,
int  Version 
)
staticinherited
virtual void GenericAPI::Log::Text::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
virtual void GenericAPI::Log::LDAS::onStreamOpen ( )
protectedvirtualinherited
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: