Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
PipelineHandler.h
1 /*
2  * The MIT License (MIT)
3  *
4  * Copyright (c) 2016 The SKA organisation
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 SKA_CHEETAH_PIPELINE_PIPELINEHANDLER_H
25 #define SKA_CHEETAH_PIPELINE_PIPELINEHANDLER_H
26 
27 #include "cheetah/data/TimeFrequency.h"
28 #include "cheetah/pipeline/DataExport.h"
29 #include "cheetah/pipeline/CheetahConfig.h"
30 
31 namespace ska {
32 namespace cheetah {
33 namespace pipeline {
34 
35 template<typename NumericalT>
36 class BeamConfig;
37 
43 template<typename NumericalT>
44 class PipelineHandler
45 {
46  public:
47  typedef data::TimeFrequency<Cpu, NumericalT> TimeFrequencyType;
48 
49  public:
50  PipelineHandler(CheetahConfig<NumericalT> const& config, BeamConfig<NumericalT> const& beam_config);
51  virtual ~PipelineHandler() = 0;
52 
56  virtual void operator()(TimeFrequencyType&) = 0;
57 
65  inline DataExport<NumericalT>& out() { return _out; }
66 
70  void halt();
71 
72  private:
73  CheetahConfig<NumericalT> const& _config;
75 };
76 
77 } // namespace pipeline
78 } // namespace cheetah
79 } // namespace ska
80 #include "detail/PipelineHandler.cpp"
81 
82 #endif // SKA_CHEETAH_PIPELINE_PIPELINEHANDLER_H
Some limits and constants for FLDO.
Definition: Brdz.h:35
virtual void operator()(TimeFrequencyType &)=0
called each time data becomes available
DataExport< NumericalT > & out()
return the data output streamer