Program Listing for File scalardata.hpp

↰ Return to documentation for file (datatypes/scalardata/scalardata.hpp)

// ---------------------------------------------------------------------
// This file is part of falcon-core.
//
// Copyright (C) 2015, 2016, 2017 Neuro-Electronics Research Flanders
//
// Falcon-server is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Falcon-server is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with falcon-core. If not, see <http://www.gnu.org/licenses/>.
// ---------------------------------------------------------------------

#pragma once

#include <string>
#include <algorithm>
#include <limits>
#include "idata.hpp"
#include "utilities/string.hpp"

#define DEFAULT_SCALAR_VALUE 0  // can be used in a template

namespace nsScalarType {

using Base = AnyType;

template <typename TYPE> struct Parameters : Base::Parameters {
  Parameters(TYPE value) : Base::Parameters(), default_value(value) {}
  TYPE default_value;
};

class Capabilities : public Base::Capabilities {};

template <typenameTYPE> class Data : public Base::Data {
 public:
  ScalarData(TYPE data = DEFAULT_SCALAR_VALUE) : data_(data) {}

  void Initialize(const Parameters<TYPE> &parameters) {
    data_ = parameters.default_value;
  }

  void ClearData() override {}

  TYPE const &data() const { return data_; }

  void set_data(const TYPE &data) { data_ = data; }

  void set_data(const Data<TYPE> &source) { data_ = source.data(); }

  friend bool operator==(Data<TYPE> &a, Data<TYPE> &b) {
    return a.data == b.data;
  }

  friend bool operator!=(Data<TYPE> &a, Data<TYPE> &b) {
    return a.data != b.data;
  }

  void SerializeBinary(std::ostream &stream,
                       Serialization::Format format =
                                   Serialization::Format::FULL) const override {
    Base::SerializeBinary(stream, format);
    if (format == Serialization::Format::FULL ||
        format == Serialization::Format::COMPACT) {
      stream.write(reinterpret_cast<const char *>(&data_), sizeof(TYPE));
    }
  }

  void SerializeYAML(YAML::Node &node,
                     Serialization::Format format =
                                 Serialization::Format::FULL) const override {
    Base::SerializeYAML(node, format);
    if (format == Serialization::Format::FULL ||
        format == Serialization::Format::COMPACT) {
      node["scalar_data"] = data_;
    }
  }

  void YAMLDescription(YAML::Node &node,
                       Serialization::Format format =
                                   Serialization::Format::FULL) const override {
    Base::YAMLDescription(node, format);
    if (format == Serialization::Format::FULL ||
        format == Serialization::Format::COMPACT) {
      node.push_back("scalar_data " + get_type_string<TYPE>() + " (1)");
    }
  }

 protected:
  TYPE data_;
};
}   // namespace nsScalarType

template <class TYPE> class ScalarType {
 public:
  static const std::string datatype() { return "scalar"; }
  static const std::string dataname() { return "data"; }

  using Base = nsScalarType::Base;
  using Parameters = nsScalarType::Parameters<TYPE>;
  using Capabilities = nsScalarType::Capabilities;
  using Data = nsScalarType::Data<TYPE>;
};