Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
ConfigurableChannelMaskConfig.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_CHANNEL_MASK_CONFIGURABLECHANNELMASKCONFIG_H
25 #define SKA_CHEETAH_CHANNEL_MASK_CONFIGURABLECHANNELMASKCONFIG_H
26 
27 
28 #include "cheetah/channel_mask/Config.h"
29 #include "cheetah/channel_mask/PolicyConfig.h"
30 #include "cheetah/channel_mask/PolicyFactory.h"
31 #include "cheetah/channel_mask/Policy.h"
32 #include <string>
33 
34 namespace ska {
35 namespace cheetah {
36 namespace channel_mask {
37 
43 template<typename NumericalRep>
45 {
46  typedef Config BaseT;
48 
49  public:
50  ConfigurableChannelMaskConfig(std::string const& tag_name="channel_mask");
52 
56  std::string const& policy_name() const;
57  std::string& policy_name();
58 
62  PolicyType& policy() const;
63 
64  protected:
65  void add_options(OptionsDescriptionEasyInit& add_options) override;
66 
67  private:
68  std::string _policy_type;
69  PolicyConfig<NumericalRep> _policy_configs;
71  mutable std::unique_ptr<PolicyType> _policy;
72 };
73 
74 
75 } // namespace channel_mask
76 } // namespace cheetah
77 } // namespace ska
78 
79 #include "detail/ConfigurableChannelMaskConfig.cpp"
80 
81 #endif // SKA_CHEETAH_CHANNEL_MASK_CONFIGURABLECHANNELMASKCONFIG_H
Base class for module configuration.
Definition: Config.h:42
std::string const & policy_name() const
the policy to apply to flagged channels
Configuration for the Configurable ChannelMask module.
Some limits and constants for FLDO.
Definition: Brdz.h:35
PolicyFactory Base class type.
Definition: Policy.h:41
PolicyType & policy() const
return the Policy object matching the configuration