Sirikata
libcore/include/sirikata/core/util/TemporalValue.hpp
Go to the documentation of this file.
00001 /*  Sirikata Utilities -- Math Library
00002  *  TemporalValue.hpp
00003  *
00004  *  Copyright (c) 2009, Daniel Reiter Horn
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions are
00009  *  met:
00010  *  * Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer.
00012  *  * Redistributions in binary form must reproduce the above copyright
00013  *    notice, this list of conditions and the following disclaimer in
00014  *    the documentation and/or other materials provided with the
00015  *    distribution.
00016  *  * Neither the name of Sirikata nor the names of its contributors may
00017  *    be used to endorse or promote products derived from this software
00018  *    without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00021  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00022  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00023  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00024  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031  */
00032 #ifndef _TEMPORAL_VALUE_HPP_
00033 #define _TEMPORAL_VALUE_HPP_
00034 
00035 #include "Time.hpp"
00036 
00037 namespace Sirikata {
00038 
00039 template <typename Value, typename TimeType>
00040 class TemporalValueBase {
00041 public:
00042     typedef TimeType Time;
00043     Value mCurrentValue;
00044     TimeType mWhen;
00045 public:
00046     TemporalValueBase(const TimeType &when, const Value&l)
00047        : mCurrentValue(l),
00048          mWhen(when){}
00049     Value extrapolate(const TimeType &t) const {
00050         return mCurrentValue.extrapolate(t-mWhen);
00051     }
00052     TimeType time() const{
00053         return mWhen;
00054     }
00055     const Value& value() const {
00056         return mCurrentValue;
00057     }
00058     void updateValue(const TimeType&t,const Value&l) {
00059         mCurrentValue=l;
00060         mWhen=t;
00061     }
00062 };
00063 
00064 template <typename Value>
00065 class TemporalValue : public TemporalValueBase<Value, Time> {
00066 public:
00067     TemporalValue()
00068      : TemporalValueBase<Value, Time>( Time(Time::null()), Value() )
00069     {}
00070     TemporalValue(const Time& when, const Value& l)
00071      : TemporalValueBase<Value, Time>(when, l)
00072     {}
00073 }; // class TemporalValue
00074 
00075 }
00076 #endif