ldas-tools-ldasgen  2.7.2
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
GenericAPI::Log::LDAS Class Referenceabstract

LDAS Logging class. More...

#include <LogLDAS.hh>

Inheritance diagram for GenericAPI::Log::LDAS:
Inheritance graph
[legend]
Collaboration diagram for GenericAPI::Log::LDAS:
Collaboration graph
[legend]

Public Types

enum  message_type {
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 ,
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 ,
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 , TF_GMT , TF_LOCAL ,
  TF_GMT , TF_LOCAL
}
 
enum  message_type {
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 ,
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 ,
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 , TF_GMT , TF_LOCAL ,
  TF_GMT , TF_LOCAL
}
 
enum  message_type {
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 ,
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 ,
  MT_OK = 0 , MT_WARN = 1 , MT_ERROR = 2 , MT_EMAIL ,
  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 , TF_GMT , TF_LOCAL ,
  TF_GMT , TF_LOCAL
}
 

Public Member Functions

 LDAS (const std::string &BaseName)
 
virtual LDASClone (const std::string &BaseName) const =0
 
virtual const char * FileExtension () const =0
 
virtual void Message (message_type MessageType, level_type Level, const std::string &Caller, const std::string &JobInfo, const std::string &Message)=0
 
virtual std::string FormatJobInfo (const std::string &JobInfo) const =0
 
 LDAS (const std::string &BaseName)
 
virtual LDASClone (const std::string &BaseName) const =0
 
virtual const char * FileExtension () const =0
 
virtual void Message (message_type MessageType, level_type Level, const std::string &Caller, const std::string &JobInfo, const std::string &Message)=0
 
virtual std::string FormatJobInfo (const std::string &JobInfo) const =0
 
 LDAS (const std::string &BaseName)
 
virtual LDASClone (const std::string &BaseName) const =0
 
virtual const char * FileExtension () const =0
 
virtual void Message (message_type MessageType, level_type Level, const std::string &Caller, const std::string &JobInfo, const std::string &Message)=0
 
virtual std::string FormatJobInfo (const std::string &JobInfo) const =0
 

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)
 
static std::string FormatTime (time_format Format, const LDASTools::AL::GPSTime &Time)
 
static std::string LogFilename (const char *Extension, int Version)
 
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...
 
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...
 
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)
 Rotate the logs according to the LDAS rules. More...
 
static std::string siteInfoLookup (const std::string &LDASSystemName)
 
static std::string siteInfoLookup (const std::string &LDASSystemName)
 

Detailed Description

LDAS Logging class.

Member Enumeration Documentation

◆ message_type [1/3]

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.

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.

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.

◆ message_type [2/3]

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.

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.

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.

◆ message_type [3/3]

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.

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.

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.

◆ time_format [1/3]

Enumerator
TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

◆ time_format [2/3]

Enumerator
TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

◆ time_format [3/3]

Enumerator
TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

TF_GMT 

Format for GMT time.

TF_LOCAL 

Format for local time.

Constructor & Destructor Documentation

◆ LDAS() [1/3]

GenericAPI::Log::LDAS::LDAS ( const std::string &  BaseName)
inline

◆ LDAS() [2/3]

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

◆ LDAS() [3/3]

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

Member Function Documentation

◆ Clone() [1/3]

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

◆ Clone() [2/3]

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

◆ Clone() [3/3]

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

◆ FileExtension() [1/3]

virtual const char* GenericAPI::Log::LDAS::FileExtension ( ) const
pure virtual

◆ FileExtension() [2/3]

virtual const char* GenericAPI::Log::LDAS::FileExtension ( ) const
pure virtual

◆ FileExtension() [3/3]

virtual const char* GenericAPI::Log::LDAS::FileExtension ( ) const
pure virtual

◆ footer() [1/3]

void GenericAPI::Log::LDAS::footer ( )
protectedvirtual

◆ footer() [2/3]

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

◆ footer() [3/3]

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

◆ FormatJobInfo() [1/3]

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

◆ FormatJobInfo() [2/3]

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

◆ FormatJobInfo() [3/3]

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

◆ FormatTime() [1/3]

std::string GenericAPI::Log::LDAS::FormatTime ( time_format  Format,
const LDASTools::AL::GPSTime &  Time 
)
static

◆ FormatTime() [2/3]

static std::string GenericAPI::Log::LDAS::FormatTime ( time_format  Format,
const LDASTools::AL::GPSTime &  Time 
)
static

◆ FormatTime() [3/3]

static std::string GenericAPI::Log::LDAS::FormatTime ( time_format  Format,
const LDASTools::AL::GPSTime &  Time 
)
static

◆ header() [1/3]

void GenericAPI::Log::LDAS::header ( )
protectedvirtual

◆ header() [2/3]

virtual void GenericAPI::Log::LDAS::header ( )
protectedvirtual

◆ header() [3/3]

virtual void GenericAPI::Log::LDAS::header ( )
protectedvirtual

◆ LogFilename() [1/3]

std::string GenericAPI::Log::LDAS::LogFilename ( const char *  Extension,
int  Version 
)
static

◆ LogFilename() [2/3]

static std::string GenericAPI::Log::LDAS::LogFilename ( const char *  Extension,
int  Version 
)
static

◆ LogFilename() [3/3]

static std::string GenericAPI::Log::LDAS::LogFilename ( const char *  Extension,
int  Version 
)
static

◆ Message() [1/3]

virtual void GenericAPI::Log::LDAS::Message ( message_type  MessageType,
level_type  Level,
const std::string &  Caller,
const std::string &  JobInfo,
const std::string &  Message 
)
pure virtual

◆ Message() [2/3]

virtual void GenericAPI::Log::LDAS::Message ( message_type  MessageType,
level_type  Level,
const std::string &  Caller,
const std::string &  JobInfo,
const std::string &  Message 
)
pure virtual

◆ Message() [3/3]

virtual void GenericAPI::Log::LDAS::Message ( message_type  MessageType,
level_type  Level,
const std::string &  Caller,
const std::string &  JobInfo,
const std::string &  Message 
)
pure virtual

◆ onStreamClose() [1/3]

void GenericAPI::Log::LDAS::onStreamClose ( )
protectedvirtual

◆ onStreamClose() [2/3]

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

◆ onStreamClose() [3/3]

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

◆ onStreamOpen() [1/3]

void GenericAPI::Log::LDAS::onStreamOpen ( )
protectedvirtual

◆ onStreamOpen() [2/3]

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

◆ onStreamOpen() [3/3]

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

◆ siteInfoLookup() [1/3]

std::string GenericAPI::Log::LDAS::siteInfoLookup ( const std::string &  LDASSystemName)
staticprotected

Rotate the logs according to the LDAS rules.

◆ siteInfoLookup() [2/3]

static std::string GenericAPI::Log::LDAS::siteInfoLookup ( const std::string &  LDASSystemName)
staticprotected

◆ siteInfoLookup() [3/3]

static std::string GenericAPI::Log::LDAS::siteInfoLookup ( const std::string &  LDASSystemName)
staticprotected

◆ writeDirect() [1/3]

void GenericAPI::Log::LDAS::writeDirect ( const std::string &  Message)
inlineprotected

Send a message immediately to the logging stream.

◆ writeDirect() [2/3]

void GenericAPI::Log::LDAS::writeDirect ( const std::string &  Message)
protected

Send a message immediately to the logging stream.

◆ writeDirect() [3/3]

void GenericAPI::Log::LDAS::writeDirect ( const std::string &  Message)
protected

Send a message immediately to the logging stream.


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