Sierra Toolkit  Version of the Day
stk_classic::RuntimeDoomedDeferred Class Reference

Class RuntimeDoomedDeferred reports a deferred fatal error message to the report system. More...

#include <RuntimeDoomed.hpp>

Public Member Functions

 RuntimeDoomedDeferred (const MessageCode &message_code)
 Creates a new RuntimeDoomedDeferred instance, setting the message code. More...
 
 ~RuntimeDoomedDeferred ()
 Destroys a RuntimeDoomed instance. More...
 
RuntimeDoomedDeferredoperator<< (OStreamFunctionPtr f)
 Member function operator<< passes the ios_base manipulator to the output stream. More...
 
RuntimeDoomedDeferredoperator<< (IOSBaseFunctionPtr f)
 Member function operator<< passes the ios_base manipulator to the output stream. More...
 
template<class T >
RuntimeDoomedDeferredoperator<< (const T &t)
 Member function operator<< passes any data type to the exception string class for conversion to a string. More...
 

Public Attributes

std::ostringstream message
 Stream to receive message header content.
 
std::ostringstream aggregate
 Stream to receive message aggregate content.
 

Detailed Description

Class RuntimeDoomedDeferred reports a deferred fatal error message to the report system.

For example:

    if (deferred_runtime_doomed_condition) {
      static MessageCode mc;
      RuntimeDoomedDeferred(mc) << "My useful message about " << some_data;
    }
    if (deferred_runtime_doomed_condition) {
      static MessageCode mc;
      RuntimeDoomedDeferred x;
      x << "My useful message about " << some_data;
      x.aggregate << proc_specific_data;
    }

Definition at line 321 of file RuntimeDoomed.hpp.

Constructor & Destructor Documentation

◆ RuntimeDoomedDeferred()

stk_classic::RuntimeDoomedDeferred::RuntimeDoomedDeferred ( const MessageCode message_code)
explicit

Creates a new RuntimeDoomedDeferred instance, setting the message code.

Parameters
message_codean MessageCode const reference to the message code associated with this message.

Definition at line 106 of file RuntimeDoomed.cpp.

◆ ~RuntimeDoomedDeferred()

stk_classic::RuntimeDoomedDeferred::~RuntimeDoomedDeferred ( )

Destroys a RuntimeDoomed instance.

The message is displayed by calling the add_deferred_message() function.

Definition at line 112 of file RuntimeDoomed.cpp.

Member Function Documentation

◆ operator<<() [1/3]

RuntimeDoomedDeferred& stk_classic::RuntimeDoomedDeferred::operator<< ( OStreamFunctionPtr  f)
inline

Member function operator<< passes the ios_base manipulator to the output stream.

Returns
a RuntimeDoomedDeferred reference to this object

Definition at line 361 of file RuntimeDoomed.hpp.

◆ operator<<() [2/3]

RuntimeDoomedDeferred& stk_classic::RuntimeDoomedDeferred::operator<< ( IOSBaseFunctionPtr  f)
inline

Member function operator<< passes the ios_base manipulator to the output stream.

Returns
a RuntimeDoomedDeferred reference to this object

Definition at line 372 of file RuntimeDoomed.hpp.

◆ operator<<() [3/3]

template<class T >
RuntimeDoomedDeferred& stk_classic::RuntimeDoomedDeferred::operator<< ( const T &  t)
inline

Member function operator<< passes any data type to the exception string class for conversion to a string.

Parameters
ta T const reference that is to be converted to a string.
Returns
a RuntimeDoomedDeferred reference to this object;

Definition at line 387 of file RuntimeDoomed.hpp.


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