src/Core/Command/CommandInfoObject.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 /**
  23  * @file CommandInfoObject.h
  24  * This file contains the CommandInfoObject class.
  25  *
  26  * @see CommandInfoObject
  27  */
  28
  29 #include "CommandObject.h"
  30
  31 /**
  32  * This template may be used in a similar way to the CommandObject template.
  33  *
  34  * The difference is that this template allows specifying additional information.
  35  * As such, this template provides only functionality to retreive that information.
  36  *
  37  * @see CommandObject
  38  */
  39 template<class T>
  40 class CommandInfoObject : public CommandObject<T>
  41 {
  42         public:
  43                 typedef void (T::*CommandFunction)(const std::string& argument); /**< The type of the function to bind on. */
  44
  45                 /** Construct a CommandInfoObject, using CommandObject to bind the specified function to the specified name. */
  46                 CommandInfoObject(const char* name, CommandFunction command, bool needobject = false, bool needlock = false, bool fullname = false);
  47
  48                 /** Whether this command requires an object. */
  49                 bool needObject() const;
  50
  51                 /** Whether this command requires a lock. */
  52                 bool needLock() const;
  53
  54         private:
  55                 bool m_needobject;
  56                 bool m_needlock;
  57 };
  58
  59 template <class T>
  60 CommandInfoObject<T>::CommandInfoObject(const char* name, CommandFunction command, bool needobject, bool needlock, bool fullname) :
  61 CommandObject<T>(name, command, fullname),
  62 m_needobject(needobject),
  63 m_needlock(needlock)
  64 {
  65
  66 }
  67
  68 template <class T>
  69 bool CommandInfoObject<T>::needObject() const
  70 {
  71         return m_needobject;
  72 }
  73
  74 template <class T>
  75 bool CommandInfoObject<T>::needLock() const
  76 {
  77         return m_needlock;
  78 }