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

#ifndef __DATASTRUCTURE_DATAITEMDESCRIPTION_H_
#define __DATASTRUCTURE_DATAITEMDESCRIPTION_H_

#include <string>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      /**
       * @Class DataItemDescription DataItemDescription.hpp "DataItemDescription.hpp"
       * @Description Class representing a description of a data item.
       * @Author Marco Barbosa
       */
      
      class DataItemDescription
      {
      
        public:
          DataItemDescription (std::string itemName, std::string itemType, bool isItemArray = false, bool isArrayStatic = false, int staticArraySize = 0);
          
          std::string getItemName();
          std::string getItemType();
          bool isItemArray();
          bool isArrayStatic();
          int getStaticArraySize();
          
        private:
          std::string itemName_;
          std::string itemType_;
          bool isItemArray_;
          bool isArrayStatic_;
          int staticArraySize_;
      }; // class DataItemDescription
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASTRUCTURE_DATAITEMDESCRIPTION_H_