Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Policy.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_RFIM_POLICY_H
25 #define SKA_CHEETAH_RFIM_POLICY_H
26 
27 #include "cheetah/rfim/PolicyInfo.h"
28 
29 namespace ska {
30 namespace cheetah {
31 namespace rfim {
32 namespace policy {
33 
39 template<typename PolicyType>
40 class Policy
41 {
42  public:
43  typedef typename PolicyInfo<PolicyType>::ReturnType ReturnType;
44  typedef typename PolicyInfo<PolicyType>::DataArgumentType ArgumentType;
45  typedef typename PolicyInfo<PolicyType>::AdapterType AdapterType;
46 
47  public:
48  Policy();
49 
59  template<typename Handler>
60  inline ReturnType exec(Handler, ArgumentType& data);
61 
65  inline ReturnType null_op(ArgumentType& data);
66 
67  private:
68  PolicyType _policy;
69 };
70 
71 
72 } // namespace policy
73 } // namespace rfim
74 } // namespace cheetah
75 } // namespace ska
76 #include "detail/Policy.cpp"
77 
78 #endif // SKA_CHEETAH_RFIM_POLICY_H
79 
std::conditional< std::is_same< void, AdapterDataReturnType >::value, DataArgumentType, AdapterDataReturnType >::type ReturnType
the data type the policy will return
Definition: PolicyInfo.h:67
Policy executor. Performs the sequence of operations required to use the Policy object Any policy co...
Definition: Policy.h:40
Some limits and constants for FLDO.
Definition: Brdz.h:35
ReturnType exec(Handler, ArgumentType &data)
start a single Policy sequence. 1) a data adapter is requested from the policy 2) the argument and th...
ReturnType null_op(ArgumentType &data)
Generates the appropriate ReturnType for the Policy but performs no actions in the data...
Definition: Policy.cpp:70
std::conditional< std::is_member_function_pointer< AdapterFuncType >::value, typename boost::mpl::at_c< boost::function_types::parameter_types< AdapterFuncType >, 1 >::type, typename boost::mpl::at_c< boost::function_types::parameter_types< AdapterFuncType >, 0 >::type >::type DataArgumentType
The argument type that is to be expected to represent the TimeFrequencyData.
Definition: PolicyInfo.h:62