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


#ifndef __DATASEMANTICS_SEMANTICNODE_H_
#define __DATASEMANTICS_SEMANTICNODE_H_

#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>

namespace mermaid
{
  namespace support
  {
    namespace data
    {
      using boost::shared_ptr;
      
      class SemanticNode;
      typedef std::vector<shared_ptr<SemanticNode> > SemanticNodeVector;
      
      /**
      * @Class SemanticNode SemanticNode.hpp "SemanticNode.hpp"
      * @Description Class representing a semantic node
      * @Author Marco Barbosa + Nelson Ramos
      */
      class SemanticNode
      {
      
          friend class SemanticTree;
          friend class SemanticTreeFactory;
          
        public:
        
          /**
          * @Description Constructor.
          * @Description Default SemanticNode constructor.
          * @Description Should not be used directly.
          */
          SemanticNode();
          
          /**
          * @Description Constructor.
          * @Description Builds a SemanticNode with a name.
          * @Argument name Node name.
          */
          SemanticNode (std::string name);
          
          /**
          * @Description Children getter.
          * @Returns The children nodes of the current SemanticNode
          */
          SemanticNodeVector getChildren();
          
          /**
          * @Description Name getter.
          * @Returns The name of the current SemanticNode
          */
          std::string getName();
          
          /**
          *
          */
          //bool aContainsB(string a, string b);
          
        private:
          std::string name_;
          SemanticNodeVector children_;
          void addChild (shared_ptr<SemanticNode> child);
          shared_ptr<SemanticNode> getChildWithName (std::string name);
          
      }; // SemanticTree
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASEMANTICS_SEMANTICNODE_H_