Home › COIN-OR Knowledge Base › Libraries › CoinUtils › CoinMessageHandler

CoinMessageHandler

Base class for message handling.

Base class for message handling.

Description

The default behavior is described here: messages are printed, and (if the severity is sufficiently high) execution will be aborted. Inherit and redefine the methods print and checkSeverity to augment the behaviour. Messages can be printed with or without a prefix; the prefix will consist of a source string, the external ID number, and a letter code, e.g., Clp6024W. A prefix makes the messages look less nimble but is very useful for "grep" etc. Usage The general approach to using the COIN messaging facility is as follows: Define your messages. For each message, you must supply an external ID number, a log (detail) level, and a format string. Typically, you define a convenience structure for this, something that's easy to use to create an array of initialised message definitions at compile time. Create a CoinMessages object, sized to accommodate the number of messages you've defined. (Incremental growth will happen if necessary as messages are loaded, but it's inefficient.) Load the messages into the CoinMessages object. Typically this entails creating a CoinOneMessage object for each message and passing it as a parameter to CoinMessages::addMessage(). You specify the message's internal ID as the other parameter to addMessage. Create and use a CoinMessageHandler object to print messages. See, for example, CoinMessage.hpp and CoinMessage.cpp for an example of the first three steps. Format codes below has a simple example of printing a message. External ID numbers and severity CoinMessageHandler assumes the following relationship between the external ID number of a message and the severity of the message: <3000 are informational ('I') <6000 warnings ('W') <9000 non-fatal errors ('E')

=9000 aborts the program (after printing the message) ('S') Log (detail) levels The default behaviour is that a message will print if its detail level is less than or equal to the handler's log level. If all you want to do is set a single log level for the handler, use setLogLevel(int). If you want to get fancy, here's how it really works: There's an array, logLevels_, which you can manipulate with setLogLevel(int,int). Each entry logLevels_[i] specifies the log level for messages of class i (see CoinMessages::class_). If logLevels_[0] is set to the magic number -1000 you get the simple behaviour described above, whatever the class of the messages. If logLevels_[0] is set to a valid log level (>= 0), then logLevels_[i] really is the log level for messages of class i. Format codes CoinMessageHandler can print integers (normal, long, and long long), doubles, characters, and strings. See the descriptions of the various << operators. When processing a standard message with a format string, the formatting codes specified in the format string will be passed to the sprintf function, along with the argument. When generating a message with no format string, each << operator uses a simple format code appropriate for its argument. Consult the documentation for the standard printf facility for further information on format codes. The special format code %? provides a hook to enable or disable printing. For each %? code, there must be a corresponding call to printing(bool). This provides a way to define optional parts in messages, delineated by the code %? in the format string. Printing can be suppressed for these optional parts, but any operands must still be supplied. For example, given the message string "A message with%? an optional integer %d and%? a double %g." installed in CoinMessages exampleMsgs with index 5, and `` hdl, the code hdl.message(5,exampleMsgs); hdl.printing(true)<<42; hdl.printing(true)<<53.5<<CoinMessageEol; will print A message with an optional integer 42 and a double 53.5. while hdl.message(5,exampleMsgs); hdl.printing(false)<<42; hdl.printing(true)<<53.5<<CoinMessageEol; will print A message with a double 53.5. For additional examples of usage, see CoinMessageHandlerUnitTest in CoinMessageHandlerTest.cpp.

Public Methods

print

Print message, return 0 normally.

int print()

checkSeverity

Check message severity - if too bad then abort.

void checkSeverity()

CoinMessageHandler

Constructor.

 CoinMessageHandler()

CoinMessageHandler

Constructor to put to file pointer (won't be closed)

 CoinMessageHandler(FILE * fp)

Parameters:

~CoinMessageHandler

Destructor.

 ~CoinMessageHandler()

CoinMessageHandler

The copy constructor.

 CoinMessageHandler(const CoinMessageHandler & )

Parameters:

operator=

Assignment operator.

CoinMessageHandler & operator=(const CoinMessageHandler & )

Parameters:

clone

Clone.

CoinMessageHandler * clone()

detail

Get detail level of a message.

int detail(int messageNumber, const CoinMessages & normalMessage)

Parameters:

logLevel

Get current log (detail) level.

int logLevel()

setLogLevel

Set current log (detail) level.

void setLogLevel(int value)

Parameters:

logLevel

Get alternative log level.

int logLevel(int which)

Parameters:

setLogLevel

Set alternative log level value.

void setLogLevel(int which, int value)

Parameters:

setPrecision

Set the number of significant digits for printing floating point numbers.

void setPrecision(unsigned int new_precision)

Parameters:

precision

Current number of significant digits for printing floating point numbers.

int precision()

setPrefix

Switch message prefix on or off.

void setPrefix(bool yesNo)

Parameters:

prefix

Current setting for printing message prefix.

bool prefix()

doubleValue

Values of double fields already processed.

double doubleValue(int position)

Parameters:

numberDoubleFields

Number of double fields already processed.

int numberDoubleFields()

intValue

Values of integer fields already processed.

CoinBigIndex intValue(int position)

Parameters:

numberIntFields

Number of integer fields already processed.

int numberIntFields()

charValue

Values of char fields already processed.

char charValue(int position)

Parameters:

numberCharFields

Number of char fields already processed.

int numberCharFields()

stringValue

Values of string fields already processed.

std::string stringValue(int position)

Parameters:

numberStringFields

Number of string fields already processed.

int numberStringFields()

currentMessage

Current message.

CoinOneMessage currentMessage()

currentSource

Source of current message.

std::string currentSource()

messageBuffer

Output buffer.

const char * messageBuffer()

highestNumber

Highest message number (indicates any errors)

int highestNumber()

filePointer

Get current file pointer.

FILE * filePointer()

setFilePointer

Set new file pointer.

void setFilePointer(FILE * fp)

Parameters:

message

Start a message.

CoinMessageHandler & message(int messageNumber, const CoinMessages & messages)

Parameters:

message

Start or continue a message.

CoinMessageHandler & message(int detail = -1)

Parameters:

message

Print a complete message.

CoinMessageHandler & message(int externalNumber, const char * source, const char * msg, char severity, int detail = -1)

Parameters:

operator<<

Process an integer parameter value.

CoinMessageHandler & operator<<(int intvalue)

Parameters:

operator<<

Process a long integer parameter value.

CoinMessageHandler & operator<<(long longvalue)

Parameters:

operator<<

Process a long long integer parameter value.

CoinMessageHandler & operator<<(long long longvalue)

Parameters:

operator<<

Process a double parameter value.

CoinMessageHandler & operator<<(double doublevalue)

Parameters:

operator<<

Process a STL string parameter value.

CoinMessageHandler & operator<<(const std::string & stringvalue)

Parameters:

operator<<

Process a char parameter value.

CoinMessageHandler & operator<<(char charvalue)

Parameters:

operator<<

Process a C-style string parameter value.

CoinMessageHandler & operator<<(const char * stringvalue)

Parameters:

operator<<

Process a marker.

CoinMessageHandler & operator<<(CoinMessageMarker )

Parameters:

finish

Finish (and print) the message.

int finish()

printing

Enable or disable printing of an optional portion of a message.

CoinMessageHandler & printing(bool onOff)

Parameters:

Source

Header: layer-0/CoinUtils/src/CoinMessageHandler.hpp

View JSON API