RuntimeMessage.hpp File Reference

#include <iosfwd>
#include <vector>
#include <cstddef>
#include <stk_util/parallel/Parallel.hpp>

Include dependency graph for RuntimeMessage.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	stk_classic::Throttle
	Class Throttle describes the cutoff limits for a message throttle. More...
struct	stk_classic::MessageCode
	Class MessageCode declares a message identifier and throttle characteristics for a message. THESE MUST BE DECLARED STATIC. More...
Namespaces
namespace	stk_classic
	Sierra Toolkit.
Typedefs
typedef ptrdiff_t	stk_classic::MessageId
	Typedef MessageId defines a message identifier.
Enumerations
enum	stk_classic::MessageType {   stk_classic::MSG_WARNING = 0,   stk_classic::MSG_DOOMED = 1,   stk_classic::MSG_EXCEPTION = 2,   stk_classic::MSG_INFORMATION = 3,   stk_classic::MSG_TYPE_MASK = 0x0FFFFFFF,   stk_classic::MSG_SYMMETRIC = 0x80000000,   stk_classic::MSG_DEFERRED = 0x40000000,   MSG_UNUSED0 = 0x20000000,   MSG_UNUSED1 = 0x10000000 }
	Enumeration MessageType declares the global message types. More...
enum	stk_classic::ThrottleGroup {   MSG_APPLICATION = 0,   MSG_TIME_STEP = 1 }
	Enumeration ThrottleGroup lists defined throttling groups. More...
Functions
unsigned	stk_classic::get_message_count (unsigned message_type)
	Member function get_message_count ...
void	stk_classic::reset_message_count (unsigned message_type)
	Member function reset_message_count ...
void	stk_classic::set_max_message_count (unsigned message_type, unsigned max_count)
	Member function set_max_message_count ...
unsigned	stk_classic::get_max_message_count (unsigned message_type)
	Member function get_max_message_count ...
const std::string &	stk_classic::get_message_name (unsigned message_type)
	Member function get_message_name ...
void	stk_classic::register_message_type (unsigned message_type, unsigned max_count, const char *name)
	Member function set_message_name ...
void	stk_classic::reset_throttle_group (int throttle_group)
	Function reset_message_group sets the count to zero of all messages in the specified throttle group.
void	stk_classic::report_message (const char *message, unsigned message_type, const MessageCode &message_code)
	Member function report_message ...
void	stk_classic::add_deferred_message (int message_type, MessageId message_id, size_t throttle_cutoff, int throttle_group, const char *header, const char *aggegrate)
	Function add_deferred_message adds a message to the deferred message queue.
void	stk_classic::report_deferred_messages (ParallelMachine comm)
	Function report_deferred_messages aggregates and reports the message on the root processor.
void	stk_classic::aggregate_messages (ParallelMachine comm, std::ostringstream &os, const char *separator=", ")
	Function aggregate_messages writes a message message to the output string by joining the messages from each processor, in order. Each message is separated by the specified separation string.
std::ostream &	stk_classic::operator<< (std::ostream &os, const MessageType &message_type)
	Function operator<< writes the message type name to the output stream. If the symmetric bit is set, "parallel" is prefixed to the name.

---

Detailed Description

Definition in file RuntimeMessage.hpp.