Unity Scopes API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
CompletionDetails.h
1 /*
2  * Copyright (C) 2014 Canonical Ltd
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Marcus Tomlinson <marcus.tomlinson@canonical.com>
17  */
18 
19 #ifndef UNITY_SCOPES_COMPLETIONDETAILS_H
20 #define UNITY_SCOPES_COMPLETIONDETAILS_H
21 
22 #include <unity/scopes/OperationInfo.h>
23 
24 #include <memory>
25 #include <string>
26 #include <vector>
27 
28 namespace unity
29 {
30 
31 namespace scopes
32 {
33 
34 namespace internal
35 {
36 
37 class CompletionDetailsImpl;
38 
39 }
40 
46 class CompletionDetails final
47 {
48 public:
55  enum CompletionStatus { OK, Cancelled, Error };
56 
62 
68  CompletionDetails(CompletionStatus status, std::string const& message);
69 
73  //{@
76 
77  CompletionDetails& operator=(CompletionDetails const& other);
80 
84 
89  CompletionStatus status() const noexcept;
90 
95  std::string message() const;
96 
102  void add_info(OperationInfo const& info);
103 
108  std::vector<OperationInfo> info_list() const;
109 
110 private:
111  std::unique_ptr<internal::CompletionDetailsImpl> p;
112 };
113 
119 
120 } // namespace scopes
121 
122 } // namespace unity
123 
124 #endif
CompletionStatus
Indicates the completion status for a query.
Definition: CompletionDetails.h:55
CompletionDetails(CompletionStatus status)
Create CompletionDetails with the given completion status.
Definition: CompletionDetails.cpp:31
std::string message() const
Get the completion message string.
Definition: CompletionDetails.cpp:70
char const * to_string(CompletionDetails::CompletionStatus status)
Convenience function to convert a CompletionDetails::CompletionStatus enumerator to a string...
Definition: CompletionDetails.cpp:95
std::vector< OperationInfo > info_list() const
Get a list of all additional operation info.
Definition: CompletionDetails.cpp:80
void add_info(OperationInfo const &info)
Add additional operation info to the info list.
Definition: CompletionDetails.cpp:75
A container for details about the completion status of a query as well as any additional information ...
Definition: CompletionDetails.h:46
CompletionStatus status() const noexcept
Get the completion status.
Definition: CompletionDetails.cpp:65
A container for details about something of interest that occurs during the operation of a request...
Definition: OperationInfo.h:43