astrotypes  0.0
IStream.h
Go to the documentation of this file.
1 /*
2  * MIT License
3  *
4  * Copyright (c) 2018 PulsarSearchSoft
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef PSS_ASTROTYPES_SIGPROC_ISTREAM_H
25 #define PSS_ASTROTYPES_SIGPROC_ISTREAM_H
26 #include "SigProcFormat.h"
29 #include <memory>
30 
31 namespace pss {
32 namespace astrotypes {
33 namespace sigproc {
34 
35 template<Header::DataType HeaderDataType>
37 {
38  typedef typename SigProcFormatAdapterSelector<HeaderDataType>::type AdapterType;
39 
40  public:
41  template<typename Stream, typename DataType>
42  static void read(Stream& s, DataType& data);
43 
44  private:
45  static AdapterType _adapter;
46 };
47 
48 template<typename HeaderT>
49 class IStream
50 {
51  public:
52  typedef HeaderT HeaderType;
53 
54  public:
58  HeaderType const& header() const;
59 
60  // read into the provided data type using the apporopriate
61  // sigproc adapter as specified in the data_types field of the
62  // header
63  template<typename Stream, typename DataType>
64  void read(Stream& s, DataType&);
65 
66  protected:
68  // in order to read the header
69  template<typename Stream>
70  void new_header(Stream& stream);
71 
72  protected:
73  HeaderT _header;
74 };
75 
76 
77 } // namespace sigproc
78 } // namespace astrotypes
79 } // namespace pss
80 #include "detail/IStream.cpp"
81 
82 #endif // PSS_ASTROTYPES_SIGPROC_ISTREAM_H
HeaderType const & header() const
the header object corresponding to the current stream
Definition: IStream.cpp:16
static void read(Stream &s, DataType &data)
Definition: IStream.cpp:10
static helper class to determine the type of SigProcFormat stream adapter given a DataaType from the ...
void new_header(Stream &stream)
inheriting class should call this every time a new sigproc stream is opened
Definition: IStream.cpp:23
void read(Stream &s, DataType &)
Definition: IStream.cpp:30