OStream.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.
 */
#ifndef PSS_ASTROTYPES_SIGPROC_OSTREAM_H
#define PSS_ASTROTYPES_SIGPROC_OSTREAM_H
#include "SigProcFormat.h"
#include "pss/astrotypes/multiarray/TypeTraits.h"
#include "pss/astrotypes/units/Time.h"
#include "pss/astrotypes/units/Frequency.h"


namespace pss {
namespace astrotypes {
namespace sigproc {

template<typename HeaderT, typename Dim1, typename Dim2>
class OStream {
        typedef SigProcFormat<Dim1, Dim2> Adapter;

    public:
        template<typename Stream, typename DataType>
        void write(Stream& s, DataType&);

    protected:
        //  in order to write out a header
        template<typename Stream>
        void new_header(Stream& stream);

    protected:
        HeaderT _header;
};

/*
template<typename T>
typename std::enable_if<pss::astrotypes::has_dimensions<T, pss::astrotypes::units::Time, pss::astrotypes::units::Frequency>::value,
std::ostream>::type& operator<<(std::ostream&, T&)
{
    // improve compile time erro messaging - we should never instantiate this function
    // as we need a SigProcFormat Adapter to know how to interpret the stream 
    static_assert(sizeof(T)==0, "attempt to use operator<< on an ostream without a SigProcFormat Adapter.");
}
*/

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

#endif // PSS_ASTROTYPES_SIGPROC_SIGPROCSTREAM_H