Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Factory.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_PRODUCERS_FACTORY_H
25 #define SKA_CHEETAH_PRODUCERS_FACTORY_H
26 
27 #include "cheetah/producers/Config.h"
28 #include <tuple>
29 #include <vector>
30 
31 namespace ska {
32 namespace cheetah {
33 namespace producers {
34 
35 template<typename DataType>
36 class Factory
37 {
38  public:
39  Factory(Config<DataType> const& source_config);
40 
44  std::vector<std::string> available() const;
45 
49  template<typename ComputeModule>
50  int exec(std::string const& stream_name, ComputeModule& pipeline);
51 };
52 
53 template<typename NumericalT>
54 class Factory<data::SpCandidateData<data::TimeFrequency<Cpu, NumericalT>>>
55 {
59 
60  public:
61  Factory(ConfigType const& producers_config);
62 
66  std::vector<std::string> available() const;
67 
71  template<typename ComputeModule>
72  int exec(std::string const& stream_name, ComputeModule& pipeline);
73 
74  private:
75  ConfigType const& _config;
76 };
77 
78 } // namespace producers
79 } // namespace cheetah
80 } // namespace ska
81 #include "detail/Factory.cpp"
82 
83 #endif // SKA_CHEETAH_PRODUCERS_FACTORY_H
std::vector< std::string > available() const
return the available source types available
Some limits and constants for FLDO.
Definition: Brdz.h:35
int exec(std::string const &stream_name, ComputeModule &pipeline)
Launch the provided pipeline using the source identified by stream_name.
Definition: Factory.cpp:36
SpCandidates associated with a single data chank.
Producer Configurations.
Definition: Config.h:41