blob: 58d16399772fe37f86f609fae6894aea7ae029f9 (
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
|
/*
* @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 CCFGWriter.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_WRITER_H_
#define FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_WRITER_H_
////////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
////////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/ns_writer.h>
#include <string>
class CCFGParser;
/*
* This class provides functionalities to write to CFG config file
*/
class CCFGWriter: public IConfigWriter {
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// CCFGWriter
/// Constructor of CCFGWriter class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
CCFGWriter();
////////////////////////////////////////////////////////////////////////////////////////////////
/// CCFGWriter
/// Constructor of CCFGWriter class
///
/// \param [IN] f_c_filepath
/// std::string - Full path of the configuration file
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
explicit CCFGWriter(const std::string &f_c_filepath);
////////////////////////////////////////////////////////////////////////////////////////////////
/// ~CCFGWriter
/// Destructor of CCFGWriter class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
~CCFGWriter();
////////////////////////////////////////////////////////////////////////////////////////////////
/// ParseFile
/// This function is used to parse the file
///
/// \param [IN] f_c_filepath
/// std::string - path of file to parse
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus ParseFile(const std::string &f_c_filepath);
////////////////////////////////////////////////////////////////////////////////////////////////
/// SetValue
/// This function is used to set the value for the key
///
/// \param [IN] f_c_key
/// std::string - key to search
/// \param [IN] f_c_value
/// std::string - value to set
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - error if key not found else eFrameworkunifiedStatusOK
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus SetValue(const std::string &f_c_key, std::string f_c_value);
////////////////////////////////////////////////////////////////////////////////////////////////
/// SaveData
/// This function is used to save the changed value to the cfg config file
///
/// \param
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus SaveData();
////////////////////////////////////////////////////////////////////////////////////////////////
/// SetDataPtr
/// This function is used to set the config file path
///
/// \param [IN] f_c_path
/// std::string - Path of file
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus SetPath(const std::string &f_c_path);
////////////////////////////////////////////////////////////////////////////////////////////////
/// SetDataPtr
/// This function is used to set the data pointer in writer class with data pointer
/// created in config reader class.
/// This is needed to avoid recreation of same data structure object in both reader and writer
/// when we create object of NSConfigParser
///
/// \param [IN] f_p_data
/// PVOID - Pointer to data structure
///
/// \return VOID
///
////////////////////////////////////////////////////////////////////////////////////////////////
VOID SetDataPtr(PVOID f_p_data);
private:
// path of config file
std::string m_cFilePath;
// CFG file parser object
CCFGParser *m_pCFGParser;
};
#endif // FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_WRITER_H_
|
