ldas-tools-ldasgen  2.7.3
Public Types | 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:
Inheritance graph
[legend]
Collaboration diagram for GenericAPI::Log::Text:
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  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  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  time_format {
  TF_GMT , TF_LOCAL , TF_GMT , TF_LOCAL ,
  TF_GMT , TF_LOCAL
}
 
enum  time_format {
  TF_GMT , TF_LOCAL , TF_GMT , TF_LOCAL ,
  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...
 
 Text (const std::string &BaseName)
 Constructor. More...
 
virtual TextClone (const std::string &BaseName) const
 Create a new instance. More...
 
 Text (const std::string &BaseName)
 Constructor. More...
 
virtual TextClone (const std::string &BaseName) const
 Create a new instance. More...
 

Protected Member Functions

void writeDirect (const std::string &Message)
 Send a message immediately to the logging stream.
 
void writeDirect (const std::string &Message)
 Send a message immediately to the logging stream.
 
void writeDirect (const std::string &Message)
 Send a message immediately to the logging stream.
 

Static Protected Member Functions

static std::string siteInfoLookup (const std::string &LDASSystemName)
 Rotate the logs according to the LDAS rules.
 

Detailed Description

Text 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

◆ Text() [1/3]

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.

◆ Text() [2/3]

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.

◆ Text() [3/3]

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

◆ Clone() [1/3]

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.

◆ Clone() [2/3]

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.

◆ Clone() [3/3]

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.


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