Ceylan::Functor Class Reference

#include <CeylanFunctor.h>

Inheritance diagram for Ceylan::Functor:

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

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

 Functor ()
 Do-nothing constructor.
virtual ~Functor () throw ()
 Virtual destructor.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Returns a user-friendly description of the state of this object.

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.

Static Protected Attributes

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

Private Member Functions

Functoroperator= (const Functor &source)
 Copy constructor cannot be private since would prevent calls such as: 'CreateFrom( Linear::Rotation2DFunctor( angle )'.


Detailed Description

Definition at line 72 of file CeylanFunctor.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

Functor::Functor (  ) 

Do-nothing constructor.

Definition at line 35 of file CeylanFunctor.cc.

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

Virtual destructor.

Definition at line 42 of file CeylanFunctor.cc.


Member Function Documentation

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

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

Copy constructor cannot be private since would prevent calls such as: 'CreateFrom( Linear::Rotation2DFunctor( angle )'.

Functor( const Functor & source ) ; Assignment operator made private to ensure that it will be never called.

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

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 Functor::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::TextDisplayable.

Reimplemented in Ceylan::Maths::Linear::Endomorphism2DFunctor, Ceylan::Maths::Linear::Rotation2DFunctor, Ceylan::Maths::Linear::Endomorphism3DFunctor, Ceylan::Maths::Linear::LineProjection3DFunctor, Ceylan::Maths::Linear::Rotation3DFunctor, Ceylan::Maths::IntToIntFunctor, Ceylan::Maths::Random::NormalProbabilityFunction, and Ceylan::Maths::Random::ProbabilityFunction.

Definition at line 49 of file CeylanFunctor.cc.


Member Data Documentation

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:07 2009 for Ceylan by  doxygen 1.5.8