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

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

#include <RuntimeDoomed.hpp>

Public Member Functions

 RuntimeDoomedSymmetric (const MessageCode &message_code=MessageCode::s_defaultMessageCode)
 Creates a new RuntimeDoomedSymmetric instance, setting the message code. More...
 
 ~RuntimeDoomedSymmetric ()
 Destroys a RuntimeDoomedSymmetric instance. More...
 
RuntimeDoomedSymmetricoperator<< (OStreamFunctionPtr f)
 Member function operator<< passes the ios_base manipulator to the output stream. More...
 
RuntimeDoomedSymmetricoperator<< (IOSBaseFunctionPtr f)
 Member function operator<< passes the ios_base manipulator to the output stream. More...
 
template<class T >
RuntimeDoomedSymmetricoperator<< (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 content.
 

Detailed Description

Class RuntimeDoomedSymmetric reports a fatal error message to the report system.

For example:

    if (symmetric_runtime_doomed_condition)
      RuntimeDoomedSymmetric() << "My useful message about " << some_data;
    if (symmetric_runtime_doomed_condition) {
      static MessageCode mc;
      RuntimeDoomedSymmetric(mc) << "My useful message about " << some_data;
    }

Definition at line 221 of file RuntimeDoomed.hpp.

Constructor & Destructor Documentation

◆ RuntimeDoomedSymmetric()

stk_classic::RuntimeDoomedSymmetric::RuntimeDoomedSymmetric ( const MessageCode message_code = MessageCode::s_defaultMessageCode)
explicit

Creates a new RuntimeDoomedSymmetric instance, setting the message code.

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

Definition at line 90 of file RuntimeDoomed.cpp.

◆ ~RuntimeDoomedSymmetric()

stk_classic::RuntimeDoomedSymmetric::~RuntimeDoomedSymmetric ( )

Destroys a RuntimeDoomedSymmetric instance.

The message is displayed by calling the report_doomed() function. However, if the count of remaining messages for this message id is zero, the message is not displayed.

Definition at line 96 of file RuntimeDoomed.cpp.

Member Function Documentation

◆ operator<<() [1/3]

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

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

Returns
a RuntimeDoomedSymmetric reference to this object

Definition at line 262 of file RuntimeDoomed.hpp.

◆ operator<<() [2/3]

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

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

Returns
a RuntimeDoomedSymmetric reference to this object

Definition at line 273 of file RuntimeDoomed.hpp.

◆ operator<<() [3/3]

template<class T >
RuntimeDoomedSymmetric& stk_classic::RuntimeDoomedSymmetric::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 RuntimeDoomedSymmetric reference to this object;

Definition at line 288 of file RuntimeDoomed.hpp.


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