Event.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project
 *
 * Copyright (C) 2010 by Sebastian Wrede <swrede at techfak dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <map>
#include <set>
#include <string>
#include <vector>

#include <boost/cstdint.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/scoped_ptr.hpp>

#include <rsc/misc/langutils.h>
#include <rsc/misc/UUID.h>
#include <rsc/runtime/Printable.h>

#include "rsb/rsbexports.h"

namespace rsb {

class EventId;
typedef boost::shared_ptr<EventId> EventIdPtr;
class MetaData;
class Scope;
typedef boost::shared_ptr<Scope> ScopePtr;

typedef boost::shared_ptr<void> VoidPtr;

class RSB_EXPORT Event: public virtual rsc::runtime::Printable {
public:

    Event();
    Event(const Event& event);

    Event(ScopePtr scope, boost::shared_ptr<void> payload,
            const std::string& type, const std::string& method = "");

    Event(Scope scope, boost::shared_ptr<void> payload,
            const std::string& type, const std::string& method = "");

    virtual ~Event();

    std::string getClassName() const;
    void printContents(std::ostream& stream) const;

    DEPRECATED(boost::uint64_t getSequenceNumber() const);

    DEPRECATED(rsc::misc::UUID getId() const);
    EventId getEventId() const;
    void setEventId(const rsc::misc::UUID& senderId, const boost::uint32_t& sequenceNumber);


    ScopePtr getScopePtr() const;
    Scope getScope() const;
    void setScopePtr(ScopePtr scope);
    void setScope(const Scope& scope);


    std::string getType() const;
    void setType(const std::string& type);

    VoidPtr getData();
    void setData(VoidPtr d);


    bool addCause(const EventId& id);

    bool removeCause(const EventId& id);

    bool isCause(const EventId& id) const;

    std::set<EventId> getCauses() const;


    std::string getMethod() const;

    void setMethod(const std::string& method);


    MetaData getMetaData() const;

    MetaData& mutableMetaData();

    void setMetaData(const MetaData& metaData);


private:

    class Impl;
    boost::scoped_ptr<Impl> d;

};

typedef boost::shared_ptr<Event> EventPtr;

typedef std::pair<std::string, boost::shared_ptr<void> > AnnotatedData;

}