Program Listing for File fixed_size_variable.hpp
↰ Return to documentation for file (include/fuse_variables/fixed_size_variable.hpp
)
/*
* Software License Agreement (BSD License)
*
* Copyright (c) 2018, Locus Robotics
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef FUSE_VARIABLES__FIXED_SIZE_VARIABLE_HPP_
#define FUSE_VARIABLES__FIXED_SIZE_VARIABLE_HPP_
#include <array>
#include <fuse_core/fuse_macros.hpp>
#include <fuse_core/serialization.hpp>
#include <fuse_core/variable.hpp>
#include <boost/serialization/access.hpp>
#include <boost/serialization/base_object.hpp>
#include <boost/serialization/array.hpp>
namespace fuse_variables
{
template<size_t N>
class FixedSizeVariable : public fuse_core::Variable
{
public:
FUSE_SMART_PTR_ALIASES_ONLY(FixedSizeVariable<N>)
constexpr static size_t SIZE = N;
FixedSizeVariable() = default;
explicit FixedSizeVariable(const fuse_core::UUID & uuid)
: fuse_core::Variable(uuid),
data_{} // zero-initialize the data array
{}
virtual ~FixedSizeVariable() = default;
size_t size() const override {return N;}
const double * data() const override {return data_.data();}
double * data() override {return data_.data();}
const std::array<double, N> & array() const {return data_;}
std::array<double, N> & array() {return data_;}
protected:
std::array<double, N> data_;
// Allow Boost Serialization access to private methods
friend class boost::serialization::access;
template<class Archive>
void serialize(Archive & archive, const unsigned int /* version */)
{
archive & boost::serialization::base_object<fuse_core::Variable>(*this);
archive & data_;
}
};
// Define the constant that was declared above
template<size_t N>
constexpr size_t FixedSizeVariable<N>::SIZE;
} // namespace fuse_variables
#endif // FUSE_VARIABLES__FIXED_SIZE_VARIABLE_HPP_