OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef COMPONENTS_VARIATIONS_PROCESSED_STUDY_H_ | 5 #ifndef COMPONENTS_VARIATIONS_PROCESSED_STUDY_H_ |
6 #define COMPONENTS_VARIATIONS_PROCESSED_STUDY_H_ | 6 #define COMPONENTS_VARIATIONS_PROCESSED_STUDY_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 #include <vector> | 9 #include <vector> |
10 | 10 |
11 #include "base/metrics/field_trial.h" | 11 #include "base/metrics/field_trial.h" |
12 | 12 |
13 namespace variations { | 13 namespace variations { |
14 | 14 |
15 class Study; | 15 class Study; |
16 | 16 |
17 // Wrapper over Study with extra information computed during pre-processing, | 17 // Wrapper over Study with extra information computed during pre-processing, |
18 // such as whether the study is expired and its total probability. | 18 // such as whether the study is expired and its total probability. |
19 class ProcessedStudy { | 19 class ProcessedStudy { |
20 public: | 20 public: |
21 // The default group used when a study doesn't specify one. This is needed | |
22 // because the field trial api requires a default group name. | |
23 static const std::string kGenericDefaultExperimentName; | |
24 | |
25 ProcessedStudy(); | 21 ProcessedStudy(); |
26 ~ProcessedStudy(); | 22 ~ProcessedStudy(); |
27 | 23 |
28 bool Init(const Study* study, bool is_expired); | 24 bool Init(const Study* study, bool is_expired); |
29 | 25 |
30 const Study* study() const { return study_; } | 26 const Study* study() const { return study_; } |
31 | 27 |
32 base::FieldTrial::Probability total_probability() const { | 28 base::FieldTrial::Probability total_probability() const { |
33 return total_probability_; | 29 return total_probability_; |
34 } | 30 } |
35 | 31 |
36 bool all_assignments_to_one_group() const { | 32 bool all_assignments_to_one_group() const { |
37 return all_assignments_to_one_group_; | 33 return all_assignments_to_one_group_; |
38 } | 34 } |
39 | 35 |
40 bool is_expired() const { return is_expired_; } | 36 bool is_expired() const { return is_expired_; } |
41 | 37 |
42 const std::string& single_feature_name() const { | 38 const std::string& single_feature_name() const { |
43 return single_feature_name_; | 39 return single_feature_name_; |
44 } | 40 } |
45 | 41 |
46 // Gets the index of the experiment with the given |name|. Returns -1 if no | 42 // Gets the index of the experiment with the given |name|. Returns -1 if no |
47 // experiment is found. | 43 // experiment is found. |
48 int GetExperimentIndexByName(const std::string& name) const; | 44 int GetExperimentIndexByName(const std::string& name) const; |
49 | 45 |
50 // Gets the default experiment name for the study, or a generic one if none is | |
51 // specified. | |
52 const std::string& GetDefaultExperimentName() const; | |
53 | |
54 static bool ValidateAndAppendStudy( | 46 static bool ValidateAndAppendStudy( |
55 const Study* study, | 47 const Study* study, |
56 bool is_expired, | 48 bool is_expired, |
57 std::vector<ProcessedStudy>* processed_studies); | 49 std::vector<ProcessedStudy>* processed_studies); |
58 | 50 |
59 private: | 51 private: |
60 // Corresponding Study object. Weak reference. | 52 // Corresponding Study object. Weak reference. |
61 const Study* study_; | 53 const Study* study_; |
62 | 54 |
63 // Computed total group probability for the study. | 55 // Computed total group probability for the study. |
64 base::FieldTrial::Probability total_probability_; | 56 base::FieldTrial::Probability total_probability_; |
65 | 57 |
66 // Whether all assignments are to a single group. | 58 // Whether all assignments are to a single group. |
67 bool all_assignments_to_one_group_; | 59 bool all_assignments_to_one_group_; |
68 | 60 |
69 // Whether the study is expired. | 61 // Whether the study is expired. |
70 bool is_expired_; | 62 bool is_expired_; |
71 | 63 |
72 // If the study has groups that enable/disable a single feature, the name of | 64 // If the study has groups that enable/disable a single feature, the name of |
73 // that feature. | 65 // that feature. |
74 std::string single_feature_name_; | 66 std::string single_feature_name_; |
75 }; | 67 }; |
76 | 68 |
77 } // namespace variations | 69 } // namespace variations |
78 | 70 |
79 #endif // COMPONENTS_VARIATIONS_PROCESSED_STUDY_H_ | 71 #endif // COMPONENTS_VARIATIONS_PROCESSED_STUDY_H_ |
OLD | NEW |