TimestampedValue.h

/* ============================================
 SF2 source code is placed under the MIT license
 Copyright (c) 2017 Kauai Labs

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ===============================================
 */

#ifndef SRC_TIME_TIMESTAMPEDVALUE_H_
#define SRC_TIME_TIMESTAMPEDVALUE_H_

#include "ITimestampedValue.h"
#include "../quantity/ICopy.h"
#include "../interpolation/IValueInterpolator.h"

template<typename T>
class TimestampedValue: public ITimestampedValue,
        public ICopy<TimestampedValue<T>>,
        public IValueInterpolator<TimestampedValue<T>> {
protected:
    T value;
    long timestamp;
    uint8_t flags;

    static const uint8_t valid_flag = 0x01;
    static const uint8_t interpolated_flag = 0x02;

public:
    TimestampedValue() {
        timestamp = 0;
        flags = 0;
    }

    TimestampedValue(T& value) {
        this->value = value;
        timestamp = 0;
        flags = 0;
    }

    TimestampedValue(T& src, long timestamp) {
        this->value = src.instantiate_copy();
        setTimestamp(timestamp);
        this->flags = 0;
    }

    TimestampedValue(TimestampedValue<T>& src) {
        this->value = src.getValue();
        this->timestamp = src.timestamp;
        this->flags = src.flags;
    }

    virtual ~TimestampedValue(){}

    long getTimestamp() {
        return timestamp;
    }

    void setTimestamp(long timestamp) {
        this->timestamp = timestamp;
    }

    void set(TimestampedValue<T>& src) {
        this->value.copy(src.value);
        this->timestamp = src.timestamp;
        this->flags = src.flags;
    }

    void set(T& src, long timestamp) {
        this->value.copy(src);
        this->timestamp = timestamp;
        this->flags = valid_flag; /* Interpolated = false */
    }

    T& getValue() {
        return value;
    }

    /* IValueInterpolator */
    bool getInterpolated() {
        return ((flags & interpolated_flag) != 0);
    }

    void setInterpolated(bool interpolated) {
        if (interpolated) {
            flags |= interpolated_flag;
        } else {
            flags &= ~interpolated_flag;
        }
    }

    void interpolate(TimestampedValue<T>& to, double time_ratio,
            TimestampedValue<T>& out) {
        TimestampedValue<T>& from = *this;
        this->value.interpolate(to.value, time_ratio, out.getValue());
        float delta_t = to.getTimestamp() - from.getTimestamp();
        delta_t *= time_ratio;
        out.setTimestamp((long) delta_t);
    }

    /* ICopy */
    void copy(TimestampedValue<T>& t) {
        this->set(t);
    }

    /* ITimestampedValue */
    bool getValid() {
        return ((flags & valid_flag) != 0);
    }

    void setValid(bool valid) {
        if (valid) {
            flags |= valid_flag;
        } else {
            flags &= ~valid_flag;
        }
    }

    TimestampedValue<T>* instantiate_copy() {
        TimestampedValue<T>* new_tsv = new TimestampedValue<T>();
        new_tsv->value = this->value;
        return new_tsv;
    }

    IQuantity& getQuantity() {
        return this->value;
    }
};

#endif /* SRC_TIME_TIMESTAMPEDVALUE_H_ */