Adhoc::Command::Note Class Reference

#include <adhoc.h>

List of all members.

Public Types
enum	Severity { Info, Warning, Error, InvalidSeverity }
Public Member Functions
	Note (Severity sev, const std::string &note)
	~Note ()
Severity	severity () const
const std::string &	content () const
Tag *	tag () const

---

Detailed Description

An abstraction of a command note.

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 129 of file adhoc.h.

---

Member Enumeration Documentation

enum Severity

Specifies the severity of a note. Enumeration values: Info  The note is informational only. This is not really an exceptional condition. Warning  The note indicates a warning. Possibly due to illogical (yet valid) data. Error  The note indicates an error. The text should indicate the reason for the error. InvalidSeverity  The note type is unknown or invalid. Definition at line 138 of file adhoc.h.

---

Constructor & Destructor Documentation

Note (  Severity  sev, const std::string &  note )  [inline]

A convenience constructor. Parameters: sev  The note's severity. note  The note's content. Definition at line 154 of file adhoc.h.

~Note (   )  [inline]

Destructor. Definition at line 160 of file adhoc.h.

---

Member Function Documentation

const std::string& content (   )  const [inline]

Returns the note's content. Returns: The note's content. Definition at line 172 of file adhoc.h.

Severity severity (   )  const [inline]

Returns the note's severity. Returns: The note's severity. Definition at line 166 of file adhoc.h.

Tag * tag (   )  const

Returns a Tag representation of the Note. Returns: A Tag representation. Definition at line 68 of file adhoc.cpp.

---

The documentation for this class was generated from the following files:

• adhoc.h
• adhoc.cpp

---