9 #ifndef STK_UTIL_ENVIRONMENT_RUNTIMEMESSAGE_HPP 10 #define STK_UTIL_ENVIRONMENT_RUNTIMEMESSAGE_HPP 16 #include <stk_util/parallel/Parallel.hpp> 62 MSG_UNUSED0 = 0x20000000,
63 MSG_UNUSED1 = 0x10000000
136 MessageCode(
size_t throttle_cutoff = 5,
int throttle_group = MSG_APPLICATION)
264 void add_deferred_message(
int message_type,
MessageId message_id,
size_t throttle_cutoff,
int throttle_group,
const char *header,
const char *aggegrate);
300 std::ostream &operator<<(std::ostream &os,
const MessageType &message_type);
308 #endif // STK_UTIL_ENVIRONMENT_RUNTIMEMESSAGE_HPP void 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.
MessageType
Enumeration MessageType declares the global message types.
Message is informational.
ptrdiff_t MessageId
Typedef MessageId defines a message identifier.
ThrottleGroup
Enumeration ThrottleGroup lists defined throttling groups.
void reset_message_count(unsigned message_type)
Member function reset_message_count ...
void register_message_type(unsigned message_type, unsigned max_count, const char *name)
Member function set_message_name ...
size_t m_count
Number which have been displayed.
Class MessageCode declares a message identifier and throttle characteristics for a message...
Throttle m_throttle
Throttle characteristics.
MessageCode(MessageId message_id, size_t throttle_cutoff, int throttle_group)
Class Throttle describes the cutoff limits for a message throttle.
const std::string & get_message_name(unsigned message_type)
Member function get_message_name ...
unsigned get_max_message_count(unsigned message_type)
Member function get_max_message_count ...
void report_message(const char *message, unsigned message_type, const MessageCode &message_code)
Member function report_message ...
unsigned get_message_count(unsigned message_type)
Member function get_message_count ...
size_t m_cutoff
Maximum number to display.
Message is a fatal error.
Throttle(size_t cutoff, int group)
void set_max_message_count(unsigned message_type, unsigned max_count)
Member function set_max_message_count ...
void reset_throttle_group(int throttle_group)
Function reset_message_group sets the count to zero of all messages in the specified throttle group...
MessageId m_id
Message identifier.
int m_group
Throttle group of message.
void report_deferred_messages(ParallelMachine comm)
Function report_deferred_messages aggregates and reports the message on the root processor.
MessageCode(size_t throttle_cutoff=5, int throttle_group=MSG_APPLICATION)
static MessageCode s_defaultMessageCode
Default message code.
void 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 fro...