lestes::msg::message Class Reference

Message wrapper. More...

#include <message.hh>

Inheritance diagram for lestes::msg::message:

Inheritance graph
[legend]
List of all members.

Public Types

enum  message_flags {
  FLG_NONE = 0x0, FLG_FATAL = 0x1, FLG_ERROR = 0x2, FLG_WARNING = 0x4,
  FLG_HINT = 0x8
}
 Type of message flags. More...
typedef enum lestes::msg::message::message_flags flags_type
 Type of message flags.

Public Member Functions

ulint kind_get (void) const
 Returns stencil kind identification.
lstring text_get (void) const
 Returns the message text.
flags_type flags_get (void) const
 Returns message flags.
bool equals (const ptr< message > &other) const
 Tests equality.

Static Public Member Functions

static ptr< messagecreate (ulint a_id, const lstring &a_text, flags_type a_flags)
 Returns new message.

Protected Member Functions

 message (const message &)
 Hides copy constructor.
messageoperator= (const message &)
 Hides assignment operator.

Protected Attributes

ulint kind
 Identification of message kind.
lstring text
 Message text.
flags_type flags
 Message flags.

Private Member Functions

 message (ulint a_id, const lstring &a_text, flags_type a_flags)
 Creates a message.

Detailed Description

Message wrapper.

Represents text message with message kind identification and flags. The message is usually returned from message stencil.


Member Typedef Documentation

typedef enum lestes::msg::message::message_flags lestes::msg::message::flags_type

Type of message flags.


Member Enumeration Documentation

enum lestes::msg::message::message_flags

Type of message flags.

Enumerator:
FLG_NONE  General message.
FLG_FATAL  Fatal error message.
FLG_ERROR  Error message.
FLG_WARNING  Warning message.
FLG_HINT  Hint message.


Constructor & Destructor Documentation

lestes::msg::message::message ( ulint  a_kind,
const lstring &  a_text,
flags_type  a_flags 
) [private]

Creates a message.

Creates a message.

Parameters:
a_kind The identification of the message kind.
a_tex The text of the message.
a_flags The flags for the message.

lestes::msg::message::message ( const message  )  [protected]

Hides copy constructor.


Member Function Documentation

ulint lestes::msg::message::kind_get ( void   )  const

Returns stencil kind identification.

Returns messsage kind identification.

Returns:
The identification number of the message kind.

lstring lestes::msg::message::text_get ( void   )  const

Returns the message text.

Returns the messsage text.

Returns:
The text of the message.

message::flags_type lestes::msg::message::flags_get ( void   )  const

Returns message flags.

Returns the messsage flags.

Returns:
The flags of the message.

bool lestes::msg::message::equals ( const ptr< message > &  other  )  const

Tests equality.

Tests equality to other message.

Parameters:
other The message to compare to.
Returns:
true If both messages have the same fields.

ptr< message > lestes::msg::message::create ( ulint  a_kind,
const lstring &  a_text,
flags_type  a_flags 
) [static]

Returns new message.

Returns new message.

Parameters:
a_kind The unique identification the message kind.
a_text The text of the message.
a_flags The flags for the message.
Returns:
The message with supplied text.

message& lestes::msg::message::operator= ( const message  )  [protected]

Hides assignment operator.


Member Data Documentation

ulint lestes::msg::message::kind [protected]

Identification of message kind.

lstring lestes::msg::message::text [protected]

Message text.

flags_type lestes::msg::message::flags [protected]

Message flags.


The documentation for this class was generated from the following files:
Generated on Mon Feb 12 18:49:40 2007 for lestes by doxygen 1.5.1-20070107