String.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 String.hpp
 * @Description String class definition.
 * @Status Implementing
 * @Version $Id: String.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa + Nelson Ramos
 */

#ifndef __DATASTRUCTURE_STRING_H_
#define __DATASTRUCTURE_STRING_H_


#include "DataValue.hpp"
#include <string>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      /**
      * @Class String String.hpp "String.hpp"
      * @Description Class representing a string data value
      * @Author Marco Barbosa + Nelson Ramos
      */
      
      class String : public DataValue
      {
      
          friend class Data;
          friend class DataFactory; //because buildString(Data * data, std::string valueString)
          
        public:
        
        
          /**
          * @Description copy method
          */
          
          String * clone();
          
          
          /**
          * @Description Value setter
          * @Argument value Value to which the String instance should be set
          */
          void setValue (std::string value);
          
          /**
          * @Description Value getter
          * @Returns Current String value
          */
          std::string getValue() const;
          
          /**
          * @Description Method to convert value to string
          */
          virtual operator std::string() const;
          
          /**
           * @Description Atribution operator. This is equivalent to String::setValue
           * @Argument value Value to which the String instance should be set
           */
          void operator= (std::string value);
          
          
        private:
        
          /**
          * @Description Default constructor
          */
          String();
          
          /**
          * @Description String constructor
          * @Argument value Initial string value
          */
          String (std::string value);
          
          
          std::string stringValue_; //< String value
      }; // class String
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASTRUCTURE_STRING_H_