relation.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2014 WYSIWYD Consortium, European Commission FP7 Project ICT-612139
 * Authors: Stéphane Lallée
 * email:   stephane.lallee@gmail.com
 * website: https://github.com/robotology/icub-client/ 
 * Permission is granted to copy, distribute, and/or modify this program
 * under the terms of the GNU General Public License, version 2 or any
 * later version published by the Free Software Foundation.
 *
 * A copy of the license can be found at
 * icub-client/license/gpl.txt
 *
 * This program 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 General
 * Public License for more details
 */

#ifndef __ICUBCLIENT_RELATION_H__
#define __ICUBCLIENT_RELATION_H__

#include "entity.h"

namespace icubclient{
    
    class Relation
    {
        friend class OPCClient;

    private:
       int   m_opcId;

    public:
        std::string  m_verb;
        std::string  m_subject;
        std::string  m_object;
        std::string  m_complement_place;
        std::string  m_complement_time;
        std::string  m_complement_manner;

        Relation() {
            m_opcId = -1;
        }
        Relation(yarp::os::Bottle &b);
        Relation(
            std::string subject, 
            std::string verb, 
            std::string object = "none", 
            std::string complement_place = "none",
            std::string complement_time = "none",
            std::string complement_manner = "none");

        Relation(
            Entity* subject, 
            Entity* verb,
            Entity* object = nullptr, 
            Entity* complement_place = nullptr,
            Entity* complement_time = nullptr,
            Entity* complement_manner = nullptr
            );

        virtual ~Relation() {}

        yarp::os::Bottle asBottle(bool ignoreID = false) const;

        yarp::os::Bottle    asLightBottle() const;

        void fromBottle(const yarp::os::Bottle &b);

        virtual std::string toString() const;

        int        ID() const;

        std::string        subject() const;

        std::string        object() const;

        std::string        verb() const;

        std::string        complement_place() const;

        std::string        complement_time() const;

        std::string        complement_manner() const;

        bool                operator==(const Relation &b) const;
        bool                operator<(const Relation &b) const;
        bool                operator>(const Relation &b) const;
    };

} //namespace

#endif