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

#ifndef __DATASTRUCTURE_DATASTRUCTUREDESCRIPTION_H_
#define __DATASTRUCTURE_DATASTRUCTUREDESCRIPTION_H_


#include <XmlElement.hpp>

#include "DataItemDescription.hpp"

#include <vector>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      using boost::shared_ptr;
      
      using mermaid::support::xml::XmlElement;
      
      /**
       * @Class DataStructureDescription DataStructureDescription.hpp "DataStructureDescription.hpp"
       * @Description Class that describes a structure of data.
       * @Author Marco Barbosa
       */
      
      class DataStructureDescription
      {
      
        public:
          DataStructureDescription (shared_ptr<XmlElement> structureDescriptionElement);
          
          std::string getName();
          
          std::vector<shared_ptr<DataItemDescription> > getItemDescriptionVector();
          
        private:
          std::string name_;
          XmlElement composition_;
          
          std::vector<shared_ptr<DataItemDescription> > itemDescriptionVector_;
          
      }; // DataStructureDescription
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif //__DATASTRUCTURE_DATASTRUCTUREDESCRIPTION_H_