#include <ZMexception.h>

Public Member Functions
	ZMexception (const std::string &mesg, const ZMexSeverity howBad=ZMexSEVERITYenumLAST, int icount=ZMexception::_classInfo.nextCount())

	ZMexception (const std::ostringstream &msg, const ZMexSeverity howBad=ZMexSEVERITYenumLAST, int icount=ZMexception::_classInfo.nextCount())

virtual	~ZMexception ()

void	location (int line, const std::string file) const

ZMexSeverity	severity () const

int	line () const

std::string	fileName () const

std::string	message () const

int	count () const

std::string	handlerUsed () const

bool	wasThrown () const

void	handlerUsed (const std::string handlerName) const

void	wasThrown (bool b) const

virtual std::string	logMessage (const std::string optText="") const

virtual std::string	facility () const

virtual std::string	name () const

bool	OKtoLog () const

virtual ZMexception *	clone () const

virtual zmex::ZMexClassInfo &	classInfo () const

virtual ZMexAction	handleMe () const

virtual ZMexLogResult	logMe () const

virtual bool	isDerivedFrom (const std::string, const std::string) const

virtual void	logObject () const

Public Attributes
	ZMexClassStaticMethods

Protected Attributes
const std::string	message_

int	line_

std::string	sourceFileName_

const ZMexSeverity	mySeverity_

const int	myCount_

std::string	handlerUsed_

bool	wasThrown_

Static Protected Attributes
static ZMexClassInfo	_classInfo

Detailed Description

Definition at line 163 of file ZMexception.h.

Constructor & Destructor Documentation

◆ ZMexception() [1/2]

zmex::ZMexception::ZMexception	(	const std::string &	mesg,
		const ZMexSeverity	howBad = `ZMexSEVERITYenumLAST`,
		int	icount = `ZMexception::_classInfo.nextCount()`
	)

◆ ZMexception() [2/2]

zmex::ZMexception::ZMexception	(	const std::ostringstream &	msg,
		const ZMexSeverity	howBad = `ZMexSEVERITYenumLAST`,
		int	icount = `ZMexception::_classInfo.nextCount()`
	)

explicit

Definition at line 199 of file ZMexception.cc.

   :
  message_(msg.str())
, line_( 0 )
, sourceFileName_( "not ZMthrow'n as of yet" )
, mySeverity_( howBad == ZMexSEVERITYenumLAST ? _classInfo.severity() : howBad )
, myCount_( icount )
, wasThrown_( false )
{ }

◆ ~ZMexception()

virtual zmex::ZMexception::~ZMexception ( )

inlinevirtual

Definition at line 216 of file ZMexception.h.

216{}

Member Function Documentation

◆ classInfo()

virtual zmex::ZMexClassInfo & zmex::ZMexception::classInfo ( ) const

inlinevirtual

Definition at line 443 of file ZMexception.h.

                                                {
    return  ZMexception::_classInfo;
  }

Referenced by facility(), handleMe(), logMe(), logMessage(), and name().

◆ clone()

virtual ZMexception * zmex::ZMexception::clone ( ) const

inlinevirtual

Definition at line 439 of file ZMexception.h.

                                      {
    return  new ZMexception ( *this );
  }

Referenced by zmex::ZMerrnoList::write().

◆ count()

int zmex::ZMexception::count ( ) const

Referenced by logMessage().

◆ facility()

std::string zmex::ZMexception::facility ( ) const

virtual

Definition at line 95 of file ZMexception.cc.

                                      {
 
  return  classInfo().facility();
 
}  // ZMexception::facility()

Referenced by logMessage().

◆ fileName()

std::string zmex::ZMexception::fileName ( ) const

Referenced by logMessage().

◆ handleMe()

virtual ZMexAction zmex::ZMexception::handleMe ( ) const

inlinevirtual

Definition at line 447 of file ZMexception.h.

                                      {
    // DEBUG  std::cerr << "ZMexception::handleMe()" << std::endl;
    return  ZMexception::classInfo().getHandler().takeCareOf( *this );
  }

Referenced by zmex::ZMthrow_().

◆ handlerUsed() [1/2]

std::string zmex::ZMexception::handlerUsed ( ) const

Referenced by display(), and zmex::ZMexHandlerBehavior::standardHandling().

◆ handlerUsed() [2/2]

void zmex::ZMexception::handlerUsed ( const std::string handlerName ) const

◆ isDerivedFrom()

virtual bool zmex::ZMexception::isDerivedFrom	(	const std::string	,
		const std::string
	)		const

inlinevirtual

Definition at line 457 of file ZMexception.h.

          {
    return  false;
  }

◆ line()

int zmex::ZMexception::line ( ) const

Referenced by logMessage().

◆ location()

void zmex::ZMexception::location	(	int	line,
		const std::string	file
	)		const

Referenced by zmex::ZMthrow_().

◆ logMe()

virtual ZMexLogResult zmex::ZMexception::logMe ( ) const

inlinevirtual

Definition at line 452 of file ZMexception.h.

                                      {
    // DEBUG  std::cerr << "ZMexception::logMe()" << std::endl;
    return ZMexception::classInfo().getLogger().emit(*this);
  }

Referenced by zmex::ZMexHandlerBehavior::standardHandling().

◆ logMessage()

std::string zmex::ZMexception::logMessage ( const std::string optText = "" ) const

virtual

Definition at line 122 of file ZMexception.cc.

                                                                 {
 
  std::ostringstream mesg;
 
  // define how each follow-on line should begin:
  #define NEXT "\n  "
 
  // Supply the exception's identification as the first line:
  mesg << facility()
       << "-" << ZMexSeverityLetter[ severity() ]
       << "-" << name() << " [#" << count() << "]";
 
  // Second line gives the exception instance's message
  mesg << NEXT << message();
 
  // Warn if this exception hits the max for its severity:
  if ( 1 == ZMexSeverityLimit[ severity() ] )
    mesg << NEXT "-- Note:  severity threshhold has been reached; "
        "logging will be suppressed "
        "for any future exceptions of this severity";
 
  // Warn if this exception hits the max for its class:
  if ( classInfo().count() == classInfo().filterMax() )
    mesg << NEXT "-- Note:  class threshhold has been reached; "
        "logging will be suppressed "
        "for any future exceptions of this class";
 
  // Insert optional text (probably from override calling this as its ancestor):
  if ( optText.length() )
    mesg << NEXT << optText;
 
  // Insert time stamp:
  ZMexLogger lgr = getLogger();
  if ( lgr.control()->isTimeDesired() ) {
    time_t now( time(0) );
    char * timeText = ctime( & now );
    timeText[24] = '\0';  // overwrite terminal '\n'
    mesg << NEXT << timeText;
  }
 
  // Identify whence we got here:
  mesg << NEXT "-- ZMthrow was issued at line " << line();
  std::string fullName = fileName();
  std::string fname;
  if ( lgr.control()->isFilePathDesired() ) {
    fname = fullName;
  } else {
    unsigned long lastSlash = fullName.find_last_of("/\\");
    if ( lastSlash == fullName.length() ) {
      fname = fullName;
    } else {
      fname = fullName.substr(lastSlash+1);
    }
  }
  mesg << NEXT "of file \"" << fname << '\"';
 
  // Identify disposition:
  mesg << NEXT "... Exception " << ( wasThrown() ? "thrown!"
                                     : "ignored"
                   );
 
  // Include optional user information, part 1:
  if ( ZMexUserActivity.length() )
    mesg << NEXT "-- ZMexUserActivity was: " << ZMexUserActivity;
 
  // Include optional user information, part 2:
  if ( ZMexUserNumericalTag )
    mesg << NEXT "-- User Numerical Tag was: " << ZMexUserNumericalTag;
 
  return  mesg.str() + '\n';
 
}  // ZMexception::logMessage()

Referenced by zmex::ZMexLogAlways::emit(), zmex::ZMexLogTwice::emit(), and zmex::ZMexValidationStyle::emit().

◆ logObject()

virtual void zmex::ZMexception::logObject ( ) const

inlinevirtual

Definition at line 464 of file ZMexception.h.

464{} //added

Referenced by zmex::ZMexLogAlways::emit(), zmex::ZMexLogTwice::emit(), and zmex::ZMexValidationStyle::emit().

◆ message()

std::string zmex::ZMexception::message ( ) const

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

◆ name()

std::string zmex::ZMexception::name ( ) const

virtual

Definition at line 106 of file ZMexception.cc.

                                  {
 
  return  classInfo().name();
 
}  // ZMexception::name()

Referenced by display(), logMessage(), main(), and zmex::ZMerrnoList::name().

◆ OKtoLog()

bool zmex::ZMexception::OKtoLog ( ) const

Referenced by zmex::ZMexHandlerBehavior::standardHandling().

◆ severity()

ZMexSeverity zmex::ZMexception::severity ( ) const

Referenced by logMessage(), zmex::ZMexHandlerBehavior::standardHandling(), zmex::ZMexThrowErrors::takeCareOf(), and zmex::ZMthrow_().

◆ wasThrown() [1/2]

bool zmex::ZMexception::wasThrown ( ) const

Referenced by display(), logMessage(), and zmex::ZMexHandlerBehavior::standardHandling().

◆ wasThrown() [2/2]

void zmex::ZMexception::wasThrown ( bool b ) const

Member Data Documentation

◆ _classInfo

ZMexClassInfo zmex::ZMexception::_classInfo

staticprotected

Definition at line 166 of file ZMexception.h.

Referenced by classInfo().

◆ handlerUsed_

std::string zmex::ZMexception::handlerUsed_

mutableprotected

Definition at line 190 of file ZMexception.h.

◆ line_

int zmex::ZMexception::line_

mutableprotected

Definition at line 177 of file ZMexception.h.

◆ message_

const std::string zmex::ZMexception::message_

protected

Definition at line 169 of file ZMexception.h.

◆ myCount_

const int zmex::ZMexception::myCount_

protected

Definition at line 186 of file ZMexception.h.

◆ mySeverity_

const ZMexSeverity zmex::ZMexception::mySeverity_

protected

Definition at line 185 of file ZMexception.h.

◆ sourceFileName_

std::string zmex::ZMexception::sourceFileName_

mutableprotected

Definition at line 181 of file ZMexception.h.

◆ wasThrown_

bool zmex::ZMexception::wasThrown_

mutableprotected

Definition at line 194 of file ZMexception.h.

◆ ZMexClassStaticMethods

zmex::ZMexception::ZMexClassStaticMethods

Definition at line 435 of file ZMexception.h.

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

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ZMexception() [1/2]

◆ ZMexception() [2/2]

◆ ~ZMexception()

Member Function Documentation

◆ classInfo()

◆ clone()

◆ count()

◆ facility()

◆ fileName()

◆ handleMe()

◆ handlerUsed() [1/2]

◆ handlerUsed() [2/2]

◆ isDerivedFrom()

◆ line()

◆ location()

◆ logMe()

◆ logMessage()

◆ logObject()

◆ message()

◆ name()

◆ OKtoLog()

◆ severity()

◆ wasThrown() [1/2]

◆ wasThrown() [2/2]

Member Data Documentation

◆ _classInfo

◆ handlerUsed_

◆ line_

◆ message_

◆ myCount_

◆ mySeverity_

◆ sourceFileName_

◆ wasThrown_

◆ ZMexClassStaticMethods