SigProcVariable.h

Go to the documentation of this file.

/*
 * MIT License
 * 
 * Copyright (c) 2018 PulsarSearchSoft
 * 
 * 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.
 */
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wall"
#pragma GCC diagnostic ignored "-Wpragmas"
#pragma GCC diagnostic ignored "-Wunused-parameter"
#pragma GCC diagnostic ignored "-Wunused-variable"
#include <boost/units/quantity.hpp>
#pragma GCC diagnostic pop

#ifndef PSS_ASTROTYPES_SIGPROC_SIGPROCVARIABLE_H
#define PSS_ASTROTYPES_SIGPROC_SIGPROCVARIABLE_H

#include <cstring>
#include <iostream>

namespace pss {
namespace astrotypes {
namespace sigproc {

template<typename T>
struct SigProcVariable
{
    static unsigned write(std::ostream&, T const& var);

    static unsigned read(std::istream&, T& var);
};

// specialisation for std::string
template<>
struct SigProcVariable<std::string>
{
    static unsigned write(std::ostream&, std::string const& var);
    static unsigned read(std::istream&, std::string& var);
};

// specialisation for boost::quantity types
template<typename Unit, typename T>
struct SigProcVariable<boost::units::quantity<Unit, T>>
{
    static unsigned write(std::ostream&, boost::units::quantity<Unit, T> const& var);
    static unsigned read(std::istream&, boost::units::quantity<Unit, T>& var);
};

// strong typing for the Header labels
struct SigProcLabel
{
    SigProcLabel() {}
    explicit SigProcLabel(std::string const& s) : _string(s) {}
    explicit SigProcLabel(const char * s) : _string(s) {}

    std::size_t size() const {
        return _string.size() + sizeof(int32_t);
    }

    inline bool operator!=(const char* txt) const {
        return std::strcmp(_string.c_str(), txt) != 0;
    }

    // allows to be stored in std::map 
    inline bool operator<(SigProcLabel const& v) const { return _string < v._string; }

    std::string const& string() const { return _string; }

    void write(std::ostream& os) const;
    void read(std::istream& is);

    private:
        std::string _string;
};

std::istream& operator>>(std::istream& stream, SigProcLabel& var);
std::ostream& operator<<(std::ostream& stream, SigProcLabel const& var);

} // namespace sigproc
} // namespace astrotypes
} // namespace pss

#include "SigProcVariable.cpp"

#endif // PSS_ASTROTYPES_SIGPROC_SIGPROCVARIABLE_H