Ceylan::TextIdentifier Class Reference

Text-only identifiers. More...

#include <CeylanTextIdentifier.h>

Inheritance diagram for Ceylan::TextIdentifier:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::TextIdentifier:

Collaboration graph
[legend]

List of all members.

Public Types

enum  TextOutputFormat { rawText, html }
 Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

 TextIdentifier ()
 Basic void constructor.
 TextIdentifier (const std::string &id)
 Constructs a TextIdentifier whose identifier is the provided string.
virtual ~TextIdentifier () throw ()
 Basic destructor, to ensure it remains virtual.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Returns a user-friendly description of the state of this object.
bool operator== (const TextIdentifier &otherIdentifier)
 Compares two text identifiers.

Static Public Member Functions

static const std::string ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
 Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat GetOutputFormat ()
 Returns the current overall text format to be used by TextDisplayable instances.
static void SetOutputFormat (TextOutputFormat newOutputFormat)
 Sets the current overall text format to be used by TextDisplayable instances.

Protected Attributes

std::string _id
 The text identifier itself.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.

Private Member Functions

 TextIdentifier (const TextIdentifier &source)
 Copy constructor made private to ensure that it will never be called.
TextIdentifieroperator= (const TextIdentifier &source)
 Assignment operator made private to ensure that it will never be called.


Detailed Description

Text-only identifiers.

See also:
Identifier.

Definition at line 48 of file CeylanTextIdentifier.h.


Member Enumeration Documentation

Defines what text output formats for TextDisplayable instances are available.

Enumerator:
rawText 
html 

Definition at line 124 of file CeylanTextDisplayable.h.


Constructor & Destructor Documentation

TextIdentifier::TextIdentifier (  ) 

Basic void constructor.

Definition at line 36 of file CeylanTextIdentifier.cc.

TextIdentifier::TextIdentifier ( const std::string &  id  )  [explicit]

Constructs a TextIdentifier whose identifier is the provided string.

Definition at line 44 of file CeylanTextIdentifier.cc.

TextIdentifier::~TextIdentifier (  )  throw () [virtual]

Basic destructor, to ensure it remains virtual.

Definition at line 53 of file CeylanTextIdentifier.cc.

Ceylan::TextIdentifier::TextIdentifier ( const TextIdentifier source  )  [private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.


Member Function Documentation

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat (  )  [static, inherited]

TextIdentifier& Ceylan::TextIdentifier::operator= ( const TextIdentifier source  )  [private]

Assignment operator made private to ensure that it will never be called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

bool TextIdentifier::operator== ( const TextIdentifier otherIdentifier  ) 

Compares two text identifiers.

Definition at line 60 of file CeylanTextIdentifier.cc.

References _id.

void TextDisplayable::SetOutputFormat ( TextOutputFormat  newOutputFormat  )  [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:
newOutputFormat the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

const std::string TextDisplayable::ToString ( std::list< TextDisplayable * >  displayables,
Ceylan::VerbosityLevels  level = Ceylan::high 
) [static, inherited]

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:
displayables a list of pointers to TextDisplayable instances/
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const string TextIdentifier::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [virtual]

Returns a user-friendly description of the state of this object.

Parameters:
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
TextDisplayable

Implements Ceylan::Identifier.

Reimplemented in Ceylan::Log::ObjectIdentifier.

Definition at line 69 of file CeylanTextIdentifier.cc.

References _id.


Member Data Documentation

std::string Ceylan::TextIdentifier::_id [protected]

The text identifier itself.

Definition at line 97 of file CeylanTextIdentifier.h.

Referenced by operator==(), and toString().

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:
Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().


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

Generated on Thu Jun 4 20:40:20 2009 for Ceylan by  doxygen 1.5.8