Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController > Class Template Reference

Generic model template, for models specifically linked to a given controller (whose class is the typename) and with no known specific view (therefore unable to manage their lifecycle). More...

#include <CeylanGenericModel.h>

Inheritance diagram for Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >:

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

 SingleControllerNoViewGenericModel (const ActualController &controller)
 Creates a new generic model, which will be linked to specified controller, whose ownership is taken, and to no view.
 SingleControllerNoViewGenericModel ()
 Creates a new generic model, which will be linked afterwards to a controller and to no view.
virtual ~SingleControllerNoViewGenericModel () 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.
virtual void addView (const BaseView &view) const =0
 Adds specified view to that model.

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

const ActualController * _controller
 The associated (unique, if any, and owned) controller.

Static Protected Attributes

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

Private Member Functions

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

Detailed Description

template<typename ActualController>
class Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >

Generic model template, for models specifically linked to a given controller (whose class is the typename) and with no known specific view (therefore unable to manage their lifecycle).

This generic model is linked to exactly one controller.

Note:
No CEYLAN_DLL declaration for templates.
See also:
testCeylanGenericMVC.cc for examples.

Definition at line 1274 of file CeylanGenericModel.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

template<typename ActualController >
Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::SingleControllerNoViewGenericModel ( const ActualController &  controller  )  [inline, explicit]

Creates a new generic model, which will be linked to specified controller, whose ownership is taken, and to no view.

Parameters:
controller the controller this model will reference.
Note:
Generally cannot be used because of the chicken-and-egg problem: on creation the controller needs its model, and this model needs its controller, both cannot be satisfied.

Definition at line 1390 of file CeylanGenericModel.h.

template<typename ActualController >
Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::SingleControllerNoViewGenericModel (  )  [inline]

Creates a new generic model, which will be linked afterwards to a controller and to no view.

Note:
Generally used because of the chicken-and-egg problem: on creation the controller needs its model, so this controller cannot be specified directly when creating this model.

Definition at line 1399 of file CeylanGenericModel.h.

template<typename ActualController >
Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::~SingleControllerNoViewGenericModel (  )  throw () [inline, virtual]

Virtual destructor.

Definition at line 1408 of file CeylanGenericModel.h.

References Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::_controller.

template<typename ActualController >
Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::SingleControllerNoViewGenericModel ( const SingleControllerNoViewGenericModel< ActualController > &  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

virtual void Ceylan::MVC::BaseModel::addView ( const BaseView &  view  )  const [pure virtual, inherited]

Adds specified view to that model.

Exceptions:
GenericMVCException if the operation failed.
Pure virtual method so that all model child classes have to choose how many views can be registered and whether they are owned by the model.

Note:
This is nevertheless a 'const' method, as adding a view is deemed not to change the state of the model itself; moreover if it was non-const, then views (which have const references to models) could not auto-register themselves to the models).

Implemented in Ceylan::MVC::NoViewModel, Ceylan::MVC::SingleViewModel, and Ceylan::MVC::MultipleViewModel.

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

template<typename ActualController >
SingleControllerNoViewGenericModel& Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::operator= ( const SingleControllerNoViewGenericModel< ActualController > &  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.

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

template<typename ActualController >
const std::string Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [inline, 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

Reimplemented from Ceylan::MVC::BaseModel.

Definition at line 1425 of file CeylanGenericModel.h.

References Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::_controller, and Ceylan::low.

Member Data Documentation

template<typename ActualController >
const ActualController* Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::_controller [protected]

The associated (unique, if any, and owned) controller.

Note:
A model should a priori never change its controller(s), (the model is expected to retrieve information directly from their model), hence the const reference.

Definition at line 1349 of file CeylanGenericModel.h.

Referenced by Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::toString(), and Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >::~SingleControllerNoViewGenericModel().

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 file:
Generated on Thu Jun 4 20:40:38 2009 for Ceylan by  doxygen 1.5.8