Boolean.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename Boolean.hpp
 * @Description Boolean class definition.
 * @Status Implementing
 * @Version $Id: Boolean.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa + Nelson Ramos
 */

// #ifndef __DATASTRUCTURE_BOOLEAN_H_
#ifdef __DATASTRUCTURE_BOOLEAN_H_ // NOT USING BOOLEAN
#define __DATASTRUCTURE_BOOLEAN_H_

#include "DataValue.hpp"

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      /**
      * @Class Boolean Boolean.hpp "Boolean.hpp"
      * @Description Class representing a boolean data value
      * @Author Marco Barbosa + Nelson Ramos
      */
      
      class Boolean : public DataValue
      {
      
          friend class Data; //because  Data::copyFrom(const Data& d) method
          friend class DataFactory; //because DataFactory::buildBoolean(Data * data, std::string valueString)
        public:
        
          /**
          * @Description Default boolean constructor
          */
          Boolean * clone();
          
          
          /**
          * @Description Boolean value setter.
          * @Argument value Value to which the Boolean instance should be set
          */
          void setValue (bool value);
          
          /**
          * @Description Boolean value getter.
          * @Returns Current value of the Boolean instance.
          */
          bool getValue() const;
          
          /**
          * @Description Method to convert value to string
          */
          virtual operator std::string() const;
          
          
        private:
        
        
          /**
          * @Description Default boolean constructor
          */
          Boolean();
          
          /**
          * @Description Boolean constructor with initial value
          * @Argument value Initial value of the Boolean instance
          */
          Boolean (bool value);
          
          
          bool boolValue_; //< Boolean value
      };
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASTRUCTURE_BOOLEAN_H_