Tick.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of CCA project
 *
 * Copyright (C) 2014 by Arne Nordmann <anordman at cor-lab 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 <iostream>

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

#include "cca/dto/DataTransferObject.h"

namespace cca {
namespace timing {

class Tick;
typedef boost::shared_ptr<Tick> TickPtr;

class Tick: public DataTransferObject {
public:
    Tick(boost::uint64_t sequenceNumber);

    virtual ~Tick();

    virtual void setSequenceNumber(boost::uint64_t sequenceNumber);
    virtual boost::uint64_t getSequenceNumber();

    virtual void setTimeStamp(boost::uint64_t timestamp);
    virtual boost::uint64_t getTimeStamp();

    virtual void setVirtualTimeStamp(boost::uint64_t timestamp);
    virtual boost::uint64_t getVirtualTimeStamp();

    virtual void setTimeStep(boost::uint64_t timestep);
    virtual boost::uint64_t getTimeStep();

    virtual void setVirtualTimeStep(boost::uint64_t timestep);
    virtual boost::uint64_t getVirtualTimeStep();

    virtual void setFactor(double factor);
    virtual double getFactor();

    virtual void setStepFactor(double factor);
    virtual double getStepFactor();

    virtual std::string print() const;

protected:
    boost::uint64_t sequenceNumber;

    boost::uint64_t timestamp;
    boost::uint64_t timestampVirtual;

    boost::uint64_t timestep;
    boost::uint64_t timestepVirtual;

    double factor;
    double stepFactor;
};

}
}