MetaData.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project.
 *
 * Copyright (C) 2011 by Johannes Wienke <jwienke 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 <boost/cstdint.hpp>
#include <boost/operators.hpp>
#include <boost/date_time.hpp>

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

#include "rsb/rsbexports.h"

namespace rsb {

class RSB_EXPORT MetaData: public virtual rsc::runtime::Printable,
        boost::equality_comparable<MetaData> {
public:

    MetaData();
    virtual ~MetaData();

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

    DEPRECATED(rsc::misc::UUID getSenderId() const);

    DEPRECATED(void setSenderId(const rsc::misc::UUID& senderId));

    boost::uint64_t getCreateTime() const;
    void setCreateTime(const boost::uint64_t& time = 0);
    void setCreateTime(const double& time);
    void setCreateTime(const boost::posix_time::ptime& time);

    boost::uint64_t getSendTime() const;
    void setSendTime(const boost::uint64_t& time = 0);
    void setSendTime(const double& time);
    void setSendTime(const boost::posix_time::ptime& time);

    boost::uint64_t getReceiveTime() const;
    void setReceiveTime(const boost::uint64_t& time = 0);
    void setReceiveTime(const double& time);
    void setReceiveTime(const boost::posix_time::ptime& time);

    boost::uint64_t getDeliverTime() const;
    void setDeliverTime(const boost::uint64_t& time = 0);
    void setDeliverTime(const double& time);
    void setDeliverTime(const boost::posix_time::ptime& time);

    std::set<std::string> userTimeKeys() const;
    bool hasUserTime(const std::string& key) const;
    boost::uint64_t getUserTime(const std::string& key) const;
    void setUserTime(const std::string& key, const boost::uint64_t& time = 0);
    void setUserTime(const std::string& key, const double& time);
    void setUserTime(const std::string& key, const boost::posix_time::ptime& time);

    std::map<std::string, boost::uint64_t>::const_iterator userTimesBegin() const;
    std::map<std::string, boost::uint64_t>::const_iterator userTimesEnd() const;

    std::set<std::string> userInfoKeys() const;
    bool hasUserInfo(const std::string& key) const;
    std::string getUserInfo(const std::string& key) const;
    void setUserInfo(const std::string& key, const std::string& value);
    std::map<std::string, std::string>::const_iterator userInfosBegin() const;
    std::map<std::string, std::string>::const_iterator userInfosEnd() const;

    bool operator==(const MetaData& other) const;

private:
    rsc::misc::UUID senderId;

    void checkedTimeStampSet(boost::uint64_t& timestamp, const boost::uint64_t& proposedValue);
    void checkedTimeStampSet(boost::uint64_t& timestamp, const double& proposedValue);
    void checkedTimeStampSet(boost::uint64_t& timestamp, const boost::posix_time::ptime& proposedValue);

    static const boost::posix_time::ptime UNIX_EPOCH;

    boost::uint64_t createTime;
    boost::uint64_t sendTime;
    boost::uint64_t receiveTime;
    boost::uint64_t deliverTime;

    std::map<std::string, boost::uint64_t> userTimes;
    std::map<std::string, std::string> userInfos;

};

RSB_EXPORT std::ostream& operator<<(std::ostream& stream, const MetaData& meta);

}