Ceylan::System::Runnable Class Reference

Basic runnable interface. More...

#include <CeylanRunnable.h>

Inheritance diagram for Ceylan::System::Runnable:

Collaboration diagram for Ceylan::System::Runnable:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

Runnable ()

Constructs an anonymous Runnable.

Runnable (const std::string &name)

virtual ~Runnable () throw ()

virtual void run ()=0

Start point method.

const std::string & getName () const

Returns the name string.

virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const =0

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

Runnable (const Runnable &source)

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

Runnable & operator= (const Runnable &source)

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

Private Attributes

std::string _name

The name of the Runnable.

Detailed Description

Basic runnable interface.

See also:: Thread, Process.

Definition at line 86 of file CeylanRunnable.h.

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

Constructor & Destructor Documentation

Runnable::Runnable ( )

Constructs an anonymous Runnable.

Definition at line 52 of file CeylanRunnable.cc.

Runnable::Runnable ( const std::string & name ) [explicit]

Definition at line 60 of file CeylanRunnable.cc.

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

Definition at line 68 of file CeylanRunnable.cc.

Ceylan::System::Runnable::Runnable ( const Runnable & source ) [private]

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

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

Member Function Documentation

const string & Runnable::getName ( ) const

Returns the name string.

Definition at line 75 of file CeylanRunnable.cc.

References _name.

Referenced by Ceylan::System::Thread::askToStop(), Ceylan::System::Thread::cancel(), Ceylan::System::Thread::Run(), Ceylan::System::Thread::run(), Ceylan::System::Thread::waitUntilOver(), and Ceylan::System::Thread::~Thread().

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

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

Definition at line 63 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().

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

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.

virtual void Ceylan::System::Runnable::run ( ) [pure virtual]

Start point method.

Exceptions:

RunnableException

if the runnable could not be run.

Implemented in Ceylan::System::Process, and Ceylan::System::Thread.

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().

virtual const std::string Ceylan::System::Runnable::toString ( Ceylan::VerbosityLevels level = Ceylan::high ) const [pure 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.

Implemented in Ceylan::System::Process, and Ceylan::System::Thread.

Member Data Documentation

std::string Ceylan::System::Runnable::_name [private]

The name of the Runnable.

Definition at line 146 of file CeylanRunnable.h.

Referenced by getName().

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:


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	Runnable ()
	Constructs an anonymous Runnable.
	Runnable (const std::string &name)
virtual	~Runnable () throw ()
virtual void	run ()=0
	Start point method.
const std::string &	getName () const
	Returns the name string.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const =0
	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
	Runnable (const Runnable &source)
	Copy constructor made private to ensure that it will be never called.
Runnable &	operator= (const Runnable &source)
	Assignment operator made private to ensure that it will be never called.
Private Attributes
std::string	_name
	The name of the Runnable.