class StatusMsg

Public Methods

•  StatusMsg ()
•  StatusMsg (const StatusMsg& msg)
•  StatusMsg (const string& header, const string border = SM_BORDER, const short hsize = head_size, const short bsize = body_size)
• void  setHeader (const string hd, const string bdr = SM_BORDER)
• void  setBoader (const string bdr)
• void  setBody (const string bdy, const string ag = SM_NULL)
• void  setBody (const string bdy, const unsigned char& ag)
• void  setBody (const string bdy, const unsigned long ag)
• string  getBody () const
• string  getArgument () const
• void  printMsg (ostream& out = cout) const

Public Static Methods

• static void  setHeaderSize (const short hsz)
• static void  setBodySize (const short msz)

Detailed Description

This base class is responsible for storing, handling, and printing status messages which consists of a header and message body. This primarily helps in simplifying the task of displaying system messages to the user and/or developer.

To make the output formating of all status messages work together, global variables were created to handle the message header and body sizes. Therefore when one of these change, it effects all status messages which use the StatusMsg base class.

See also: Log, Error

Sets default message of SM_DBODY[]

Copy constructor

Sets default message of SM_DBODY[] along with specified string header and with border style, header size, and body size if needed.

Parameters:

header	Header of status message
border	Default header border: SM_BORDER[]
hsize	Default header size for all objects: SM_HDRSZ
bsize	Default body size for all objects: SM_BODYSZ

Set header of message along with boarder style if needed

Parameters:

hd	Header
bdr	Header border

Set boarder style

Parameters:

bdr	Header border

Set body of message along with one string argument if needed

Parameters:

bdy	Status message
ag	Argument associated with message. Only able to handle one but might handle more in the future if needed. By default the argument is none.

Same as above but handles an unsigned character for the argument

Same as above but handles an unsigned integer for the argument

[static]

Set header size for all StatusMsg objects. This method can be called either by an object or directly within the class by "StatusMsg::setHeaderSize(size)". If the actual string size of the header is less then this size, then spaces are appended to the header when displayed. And if the string size is greater than this size then the header is truncated when displayed.

Parameters:

hsz	Header Size. If 0, then a header is not displayed.

[static]

Set message body size for all StatusMsg object. This method can be called either by an object or directly within the class by "StatusMsg::setBodySize(size)". If the actual string size is less than this size and an arguement exists, then spaces are added in between when displayed. And if the string size is greater than this size then the message is truncated when displayed.

Parameters:

msg	Message Body Size

[const]

Returns: body of message

[const]

Returns: argument of message

[const]

Display status message with the appropriate formatting of the header and message body along with its argument if it exists. A default message would look something like:

 |header|  Default Message               [Argument]

Parameters:

out	ostream to output onto (default: cout)