Tick.cpp

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
 *
 * ============================================================ */

#include "Tick.h"

#include <limits>
#include <sstream>

#include <boost/format.hpp>
#include <boost/algorithm/string.hpp>

#include <rsc/misc/langutils.h>

using namespace std;
using namespace boost;
using namespace boost::algorithm;

namespace cca {
namespace timing {

Tick::Tick(boost::uint64_t seq) :
        DataTransferObject(), sequenceNumber(seq),
                timestamp(rsc::misc::currentTimeMicros()), timestampVirtual(0),
                timestep(0), timestepVirtual(0), factor(0), stepFactor(0) {
}

Tick::~Tick() {
}

void Tick::setSequenceNumber(boost::uint64_t seq) {
    sequenceNumber = seq;
}

boost::uint64_t Tick::getSequenceNumber() {
    return sequenceNumber;
}

void Tick::setTimeStamp(boost::uint64_t ts) {
    timestamp = ts;
}

boost::uint64_t Tick::getTimeStamp() {
    return timestamp;
}

void Tick::setVirtualTimeStamp(boost::uint64_t ts) {
    timestampVirtual = ts;
}

boost::uint64_t Tick::getVirtualTimeStamp() {
    return timestampVirtual;
}

void Tick::setTimeStep(boost::uint64_t ts) {
    timestep = ts;
}

boost::uint64_t Tick::getTimeStep() {
    return timestep;
}

void Tick::setVirtualTimeStep(boost::uint64_t ts) {
    timestepVirtual = ts;
}

boost::uint64_t Tick::getVirtualTimeStep() {
    return timestepVirtual;
}

void Tick::setFactor(double f) {
    factor = f;
}

double Tick::getFactor() {
    if (factor < 10 * numeric_limits<double>::epsilon()) {
        // Factor is null
        if ((timestamp > 10 * numeric_limits<double>::epsilon())
                && (timestampVirtual > 10 * numeric_limits<double>::epsilon())) {
            // Timestamp and virtual timestamp set, so we can calculate
            return timestampVirtual / timestamp;
        }
    }

    return factor;
}

void Tick::setStepFactor(double f) {
    stepFactor = f;
}

double Tick::getStepFactor() {
    if (stepFactor < 10 * numeric_limits<double>::epsilon()) {
        // Factor is null
        if ((timestep > 10 * numeric_limits<double>::epsilon())
                && (timestepVirtual > 10 * numeric_limits<double>::epsilon())) {
            // Timestamp and virtual timestamp set, so we can calculate
            return timestepVirtual / timestep;
        }
    }

    return stepFactor;
}

std::string Tick::print() const {
    return str(
            format(
                    "<Tick (sequenceNumber=%d, timestamp=%d, "
                    "timestampVirtual=%d, timestep=%d, timestepVirtual=%d)>")
                    % sequenceNumber
                    % timestamp
                    % timestampVirtual
                    % timestep
                    % timestepVirtual);
}

}
}