blob: 788b6a4f732c29fbec723400b7cbae25c142de37 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
////////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_NS_ConfigParser
/// \brief This file contains declaration of class IConfigWriter.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
/**
* @file ns_writer.h
* @brief \~english This file contains declaration of class IConfigWriter.
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
#ifndef __FRAMEWORKUNIFIED_NATIVESERVICES_NSCONFIGPARSER_INC_CONFIG_WRITER_H__ // NOLINT (build/header_guard)
#define __FRAMEWORKUNIFIED_NATIVESERVICES_NSCONFIGPARSER_INC_CONFIG_WRITER_H__ // NOLINT(build/header_guard)
////////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
////////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_types.h> // NOLINT(build/header_guard)
#include <string>
/**
* @class IConfigWriter
* \~english @brief Config writer abstract class.
* \~english @par Brief Introduction
* IConfigWriter is an abstract class which is inherited by\n
* different type configuration file writer class.
*
*/
class IConfigWriter {
public:
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup IConfigWriter
/// \~english @par Brief
/// Constructor of IConfigWriter class
/// \~english @param None
/// \~english @retval none
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// - To get a instance of this class.
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see ~IConfigWriter
////////////////////////////////////////////////////////////////////////////////////
IConfigWriter();
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup ~IConfigWriter
/// \~english @par Brief
/// Destructor of IConfigWriter class
/// \~english @param None
/// \~english @retval none
/// \~english @par Preconditons
/// - Calls constructor to successfully create object.
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// - Destruct the object of this class.
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see IConfigWriter
////////////////////////////////////////////////////////////////////////////////////
virtual ~IConfigWriter();
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup IConfigWriter
/// \~english @par Brief
/// This function is used to parse the file.
/// \~english @param [in] f_c_filepath
/// std::string - path of file to parse
/// \~english @retval EFrameworkunifiedStatus - success or failure
/// \~english @par Preconditons
/// - Calls constructor to successfully create object.
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This function is used to parse the file.
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus ParseFile(const std::string &f_c_filepath) = 0;
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup IConfigWriter
/// \~english @par Brief
/// This function is used to set the value for the key
/// \~english @param [in] f_c_key
/// std::string - key to search
/// \~english @param [in] f_c_value
/// std::string - value to set
/// \~english @retval EFrameworkunifiedStatus - error if key not found else eFrameworkunifiedStatusOK
/// \~english @par Preconditons
/// - Calls constructor to successfully create object.
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This function is used to set the value for the key
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus SetValue(const std::string &f_c_key, std::string f_c_value) = 0;
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup IConfigWriter
/// \~english @par Brief
/// This function is used to save the changed value permanently to the config source
/// \~english @param None
/// \~english @retval none
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This function is used to save the changed value permanently to the config source
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus SaveData() = 0;
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup IConfigWriter
/// \~english @par Brief
/// This function is used to set the config file path
/// \~english @param [in] f_cpath
/// std::string - Path of file
/// \~english @retval EFrameworkunifiedStatus - success or failure
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This function is used to set the config file path
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
virtual EFrameworkunifiedStatus SetPath(const std::string &f_cpath) = 0;
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup IConfigWriter
/// \~english @par Brief
/// This function is used to set the data pointer in config writer class with data pointer\n
/// created in config reader class.\n
/// This is needed to avoid recreation of same data structure object in both reader and writer\n
/// when we create object of NSConfigParser.\n
/// \~english @param [in] f_pdata
/// PVOID - Pointer to data structure
/// \~english @retval None
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - None
/// \~english @par Conditions of processing failure
/// - None
/// \~english @par Detail
/// This function is used to set the data pointer in config writer class with data pointer\n
/// created in config reader class.\n
/// This is needed to avoid recreation of same data structure object in both reader and writer\n
/// when we create object of NSConfigParser.\n
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - Sync only
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
virtual VOID SetDataPtr(PVOID f_pdata) = 0;
};
#endif /* __FRAMEWORKUNIFIED_NATIVESERVICES_NSCONFIGPARSER_INC_CONFIG_WRITER_H__ */ // NOLINT (build/header_guard)
/** @}*/ // end of framework_unified
/** @}*/ // end of native_service
/** @}*/ // end of BaseSystem
|
