Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
EmulatorAppConfig.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_EMULATOR_EMULATORAPPCONFIG_H
25 #define SKA_CHEETAH_EMULATOR_EMULATORAPPCONFIG_H
26 
27 #include "panda/BasicAppConfig.h"
28 #include "cheetah/emulator/Config.h"
29 #include <string>
30 #include <vector>
31 
32 namespace ska {
33 namespace cheetah {
34 namespace emulator {
35 
44 class EmulatorAppConfig : public ska::panda::BasicAppConfig
45 {
46  public:
47  enum class Stream { SkaLow, SkaMid };
48 
49  public:
50  EmulatorAppConfig(std::string const& app_name, std::string const& description);
51  EmulatorAppConfig(EmulatorAppConfig const&) = delete;
53 
57  void set_generator_list(std::vector<std::string> const& generator_names);
58 
62  std::vector<std::string> const& generator_list() const;
63 
64  ska::cheetah::emulator::Config& emulator_config();
65 
69  Stream stream_type() const;
70 
71  protected:
72  std::string version() const override;
73 
74  protected:
75  void add_options(OptionsDescriptionEasyInit& add_options) override;
76 
77  private:
78  ska::cheetah::emulator::Config _emulator_config;
79  std::vector<std::string> _generator_keys;
80  Stream _stream_type;
81 };
82 
83 
84 } // namespace emulator
85 } // namespace cheetah
86 } // namespace ska
87 
88 #endif // SKA_CHEETAH_EMULATOR_EMULATORAPPCONFIG_H
std::vector< std::string > const & generator_list() const
list the known generators
Some limits and constants for FLDO.
Definition: Brdz.h:35
Configuration options for the Emulator.
Definition: Config.h:50
Top level configuration for the emulator app.
Stream stream_type() const
the type of UDP stream to generate
void set_generator_list(std::vector< std::string > const &generator_names)
set the known generators