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


#ifndef __DATASEMANTICS_SEMANTICTREE_H_
#define __DATASEMANTICS_SEMANTICTREE_H_

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



namespace mermaid
{
  namespace support
  {
    namespace data
    {
      using boost::shared_ptr;
      
      /**
      * @Class SemanticTree SemanticTree.hpp "SemanticTree.hpp"
      * @Description Class representing a semantic tree
      * @TODO restingir construção da arvore para apenas haver um nó por cada nome
      * @Author Marco Barbosa + Nelson Ramos
      */
      
      class SemanticTree
      {
      
        public:
        
          /**
          * @Description Constructor.
          * @Description Default constructor of a SemanticTree.
          * @Description It doesn't return a valid SemanticTree.
          */
          //SemanticTree();
          
          /**
          * @Description Constructor.
          * @Description It builds a semantic tree based on a root node.
          * @Argument rootNode The root node of the tree
          */
          SemanticTree (shared_ptr<SemanticNode> rootNode);
          
          /**
          * @Description Root node getter.
          * @Returns The tree's root node.
          */
          shared_ptr<SemanticNode> getRootNode();
          
          /**
          * @Description Checks if concept A is contained in concept B
          * @Parameter a Concept A
          * @Parameter b Concept B
          * @Returns TRUE if A is contained in B, FALSE otherwise
          */
          bool aContainsB (std::string a, std::string b);
          
        private:
          shared_ptr<SemanticNode> rootNode_;
          
      }; // SemanticTree
    } // namespace data
  } // namespace support
} // namespace mermaid

#endif // __DATASEMANTICS_SEMANTICTREE_H_