zmex Namespace Reference

Classes
class	ZMerrnoList
class	ZMexception
class	ZMexClassInfo
class	ZMexHandler
class	ZMexHandlerBehavior
class	ZMexHandleViaParent
class	ZMexIgnoreAlways
class	ZMexIgnoreNextN
class	ZMexLogAlways
class	ZMexLogBehavior
class	ZMexLogger
class	ZMexLogNever
class	ZMexLogTwice
class	ZMexLogViaParent
class	ZMexThrowAlways
class	ZMexThrowErrors
class	ZMexValidationStyle

Enumerations
enum	ZMexAction { ZMexThrowIt , ZMexIgnoreIt , ZMexHANDLEVIAPARENT }
enum	ZMexLogResult { ZMexLOGGED , ZMexNOTLOGGED , ZMexLOGVIAPARENT }
enum	ZMexSeverity {   ZMexNORMAL , ZMexINFO , ZMexWARNING , ZMexERROR ,   ZMexSEVERE , ZMexFATAL , ZMexPROBLEM , ZMexSEVERITYenumLAST }

Functions
ZMexHandler &	ZMhandler ()
ZMexLogger &	ZMlogger ()
ZMexAction	ZMthrow_ (const ZMexception &userException, int lineNum, const char fileName[])

Variables
ZMerrnoList	ZMerrno
std::string	ZMexUserActivity = ""
int	ZMexUserNumericalTag = 0
const std::string	ZMexSeverityName [ZMexSEVERITYenumLAST]
const char	ZMexSeverityLetter [ZMexSEVERITYenumLAST]
int	ZMexSeverityLimit [ZMexSEVERITYenumLAST]

Enumeration Type Documentation

ZMexAction

enum zmex::ZMexAction

Enumerator
ZMexThrowIt
ZMexIgnoreIt
ZMexHANDLEVIAPARENT

Definition at line 20 of file ZMexAction.h.

{ ZMexThrowIt, ZMexIgnoreIt, ZMexHANDLEVIAPARENT };

ZMexLogResult

enum zmex::ZMexLogResult

Enumerator
ZMexLOGGED
ZMexNOTLOGGED
ZMexLOGVIAPARENT

Definition at line 19 of file ZMexLogResult.h.

{ ZMexLOGGED, ZMexNOTLOGGED, ZMexLOGVIAPARENT };

ZMexSeverity

enum zmex::ZMexSeverity

Enumerator
ZMexNORMAL
ZMexINFO
ZMexWARNING
ZMexERROR
ZMexSEVERE
ZMexFATAL
ZMexPROBLEM
ZMexSEVERITYenumLAST

Definition at line 32 of file ZMexSeverity.h.

                  {
 
  ZMexNORMAL,
    // All is well; always safe to ignore; typically not worth logging
    // since it's probably just a temporary placeholder.
  ZMexINFO,
    // In the normal course of events, here is news worth logging;
    // always safe to ignore; often useful for progress reporting and
    // for debugging purposes.
  ZMexWARNING,
    // Something unusual has happened, but we have a quite reasonable
    // action to take; it's generally safe to ignore the warning because
    // you'll probably get just about the result you intended; logging
    // can probably cease after (say) 50 of the same warnings.
  ZMexERROR,
    // We encountered something such that, although we can make it safe
    // to continue running (e.g., by supplying a default value instead of
    // a value we can't for some reason calculate), you probably won't
    // get the result you expected unless you handle this yourself; ought
    // always be logged (but may be sensible, if hundreds of the same
    // error are intentionally ignored, to stop logging each one).
  ZMexSEVERE,
    // The action you intended will almost certainly have a seriously
    // flawed outcome and we doubt that either we or you can make it safe
    // to continue if you ignore this; ought always be logged.
  ZMexFATAL,
    // We can make no representations as to the state of any part of the
    // software, even of software parts not obviously associated with the
    // failed intended action and even if you try to handle the problem;
    // ought always be logged and essentially never be ignored.
  ZMexPROBLEM,
    // The software has reached a logically impossible internal state;
    // must always be logged and never be ignored; if encountered, should
    // always be reported to the software's developers and/or maintainers.
  ZMexSEVERITYenumLAST
    // Not a true severity level; useful to count the number of distinct
    // severity levels and, as such, must always be physically last
    // within this enum's definition.
 
};  // ZMexSeverity

Function Documentation

ZMhandler()

ZMexHandler & zmex::ZMhandler

(

)

Definition at line 65 of file ZMexception.cc.

                            {
  static ZMexHandler ZMhandler = ZMexHandler( ZMexThrowErrors() );
  return ZMhandler;
}  // ZMhandler()

Referenced by ZMhandler().

ZMlogger()

ZMexLogger & zmex::ZMlogger

(

)

Definition at line 70 of file ZMexception.cc.

                          {
  static ZMexLogger ZMlogger = ZMexLogger(  ZMexLogAlways() );
  return  ZMlogger;
}

Referenced by display(), main(), and ZMlogger().

ZMthrow_()

ZMexAction zmex::ZMthrow_	(	const ZMexception &	userException,
		int	lineNum,
		const char	fileName[]
	)

Definition at line 35 of file ZMthrow.cc.

   {
 
  // a) Place the lineNum and fileName information into the exception object.
 
  // b) Cause the handler to be invoked via x.X::handleMe().
  //    That finds the handler, puts the handler name into the exception,
  //    and invokes the handler's takeCareOf() method, passing it the
  //    exception object so that, if any parent handlers are involved,
  //    you later have x.Y::handleMe() invoked, where Y is an ancestor of X.
 
  // c) If the exception is of severity ZMexERROR or higher, copy the
  //    exception object onto ZMerrno.
 
  // d) Return the result of the handler's decision.
 
  // The following are done elsewhere, so ZMthrow_ does not have to:
  //   The constructor for ZMexception takes care of incrementing
  //     the static count, and saving its value.
  //   The handler notifies the exception object of the handler's
  //     decision whether to have the object be thrown or ignored.
  //   Identifying the logger to call, and saving that information,
  //     in this exception instance, is done by x.logMe()
  //     called by handler, assuming the handler decides to log.
 
  userException.location( lineNum, fileName );      // (a)
 
  ZMexAction whatToDo = userException.handleMe();   // (b)
 
  if ( userException.severity() >= ZMexERROR )      // (c)
    ZMerrno.write( userException );
 
  return whatToDo;                  // (d)
 
}  // ZMthrow_()

Variable Documentation

ZMerrno

ZMerrnoList zmex::ZMerrno

Definition at line 40 of file ZMerrno.cc.

Referenced by main(), and ZMthrow_().

ZMexSeverityLetter

const char zmex::ZMexSeverityLetter

Initial value:

= {
  ' ',      
  'I',      
  'W',      
  'E',      
  'S',      
  'F',      
  '?',      
}

Definition at line 34 of file ZMexSeverity.cc.

Referenced by zmex::ZMexception::logMessage().

ZMexSeverityLimit

int zmex::ZMexSeverityLimit

Initial value:

= {
  
  -1,       
  -1,       
  -1,       
  -1,       
  -1,       
  -1,       
  -1,       
}

Definition at line 45 of file ZMexSeverity.cc.

Referenced by zmex::ZMexception::logMessage(), zmex::ZMexHandler::setLogLimit(), and zmex::ZMexHandlerBehavior::standardHandling().

ZMexSeverityName

const std::string zmex::ZMexSeverityName

Initial value:

= {
  "NORMAL",         
  "INFORMATIONAL",      
  "WARNING",            
  "ERROR",          
  "SEVERE",         
  "FATAL",          
  "UNANTICIPATED PROBLEM",  
}

Definition at line 23 of file ZMexSeverity.cc.

ZMexUserActivity

std::string zmex::ZMexUserActivity = ""

Definition at line 55 of file ZMexception.cc.

Referenced by zmex::ZMexception::logMessage().

ZMexUserNumericalTag

int zmex::ZMexUserNumericalTag = 0

Definition at line 56 of file ZMexception.cc.

Referenced by zmex::ZMexception::logMessage().