-/************************************************************************************//*!
- * Name: @file functor.h
- * Purpose: @brief defines TFunctor class
- * Author: @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified: 2011-05-18
- * Copyright:
- * License:
- ***************************************************************************************/
+/*# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+# pour la Sant�)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+# Previous Authors : Laurent Guigues, Jean-Pierre Roux
+# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+#
+# This software is governed by the CeCILL-B license under French law and
+# abiding by the rules of distribution of free software. You can use,
+# modify and/ or redistribute the software under the terms of the CeCILL-B
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+# or in the file LICENSE.txt.
+#
+# As a counterpart to the access to the source code and rights to copy,
+# modify and redistribute granted by the license, users are provided only
+# with a limited warranty and the software's author, the holder of the
+# economic rights, and the successive licensors have only limited
+# liability.
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------ */
+
+/*!
+ * @file functor.h
+ * @brief Defines TFunctor class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 2011-06-02
+ */
#ifndef TFUNCTOR_H_
#define TFUNCTOR_H_
-//! @include <string>
#include <string>
+#include <exception>
-//! @namespace <creaButtonContainer>
+/*! @namespace <creaButtonContainer>
+ * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
namespace creaButtonContainer
{
- //! @namespace <model>
+ /*! @namespace <creaButtonContainer::model>
+ * @brief Contains the implementation of the model in creaButtonContainer library.
+ * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+ */
namespace model
{
+ //typedef definition.
/*! @typedef std::string ButtonIDType;
* @brief Defines the ButtonIDType type.
*/
typedef std::string ButtonIDType;
-
+ //end of typedef definition
/*! @class TFunctor functor.h "functor.h"
* @brief This is an abstract class for call_back functions.
*/
// derived template class
/*! @tparam <typename TClass>
- * @brief It makes TConcreteFunctor usable for all Classes.
+ * @brief TClass makes TConcreteFunctor usable for all Classes.
*/
template< typename TClass >
/*! @class TConcreteFunctor: public TFunctor functor.h "functor.h"
- * @brief This class contains the ButtonContainer factory.
- * This class describes the factory of the ButtonContainer using design patterns.
+ * @brief This class allows to make call_back functions.
*/
class TConcreteFunctor : public TFunctor
{
* @brief Override operator "()". Execute member function.
* @see TFunctor
* @param buttonName
+ * @exception std::bad_alloc
*/
virtual void
operator()( const ButtonIDType &buttonName );
* @brief Override function "Call". Execute member function
* @see TFunctor
* @param buttonName
+ * @exception std::bad_alloc
*/
virtual void
Call( const ButtonIDType &buttonName );
// -------------------------------------------------------------------------------
private:
- void (TClass::*fpt)( const ButtonIDType &buttonName ); //! <void (TClass::*fpt) Pointer to member function.
+ void
+ (TClass::*fpt)( const ButtonIDType &buttonName ); //! <void (TClass::*fpt) Pointer to member function.
TClass* pt2Object; //! <TClass* pointer to object.
};