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
|
/*
* Copyright (c) 2011-2014, Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "BinarySerializableElement.h"
#include "XmlSerializingContext.h"
#include "XmlDomainImportContext.h"
#include "SyncerSet.h"
#include <list>
#include <set>
#include <map>
#include <string>
class CConfigurableElement;
class CDomainConfiguration;
class CParameterBlackboard;
class CSelectionCriteriaDefinition;
class CConfigurableDomain : public CBinarySerializableElement
{
typedef std::list<CConfigurableElement*>::const_iterator ConfigurableElementListIterator;
typedef std::map<const CConfigurableElement*, CSyncerSet*>::const_iterator ConfigurableElementToSyncerSetMapIterator;
public:
CConfigurableDomain();
CConfigurableDomain(const std::string& strName);
virtual ~CConfigurableDomain();
// Sequence awareness
void setSequenceAwareness(bool bSequenceAware);
bool getSequenceAwareness() const;
// Configuration Management
bool createConfiguration(const std::string& strName, const CParameterBlackboard* pMainBlackboard, std::string& strError);
bool deleteConfiguration(const std::string& strName, std::string& strError);
bool renameConfiguration(const std::string& strName, const std::string& strNewName, std::string& strError);
bool restoreConfiguration(const std::string& strName, CParameterBlackboard* pMainBlackboard, bool bAutoSync, std::list<std::string>& strError) const;
bool saveConfiguration(const std::string& strName, const CParameterBlackboard* pMainBlackboard, std::string& strError);
bool setElementSequence(const std::string& strConfiguration, const std::vector<std::string>& astrNewElementSequence, std::string& strError);
bool getElementSequence(const std::string& strConfiguration, std::string& strResult) const;
bool setApplicationRule(const std::string& strConfiguration, const std::string& strApplicationRule, const CSelectionCriteriaDefinition* pSelectionCriteriaDefinition, std::string& strError);
bool clearApplicationRule(const std::string& strConfiguration, std::string& strError);
bool getApplicationRule(const std::string& strConfiguration, std::string& strResult) const;
// Last applied configuration name
std::string getLastAppliedConfigurationName() const;
// Pending configuration name
std::string getPendingConfigurationName() const;
// Associated Configurable elements
void gatherConfigurableElements(std::set<const CConfigurableElement*>& configurableElementSet) const;
void listAssociatedToElements(std::string& strResult) const;
// Configurable elements association
bool addConfigurableElement(CConfigurableElement* pConfigurableElement, const CParameterBlackboard* pMainBlackboard, std::string& strError);
bool removeConfigurableElement(CConfigurableElement* pConfigurableElement, std::string& strError);
// Blackboard Configuration and Base Offset retrieval
CParameterBlackboard* findConfigurationBlackboard(const std::string& strConfiguration,
const CConfigurableElement* pConfigurableElement,
uint32_t& uiBaseOffset,
bool& bIsLastApplied,
std::string& strError) const;
// Domain splitting
bool split(CConfigurableElement* pConfigurableElement, std::string& strError);
// Ensure validity on whole domain from main blackboard
void validate(const CParameterBlackboard* pMainBlackboard);
// Configuration application if required
void apply(CParameterBlackboard* pParameterBlackboard, CSyncerSet* pSyncerSet, bool bForced) const;
// Return applicable configuration validity for given configurable element
bool isApplicableConfigurationValid(const CConfigurableElement* pConfigurableElement) const;
// From IXmlSink
virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
// From IXmlSource
virtual void toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
virtual void childrenToXml(CXmlElement& xmlElement,
CXmlSerializingContext& serializingContext) const;
// Class kind
virtual std::string getKind() const;
protected:
// Content dumping
virtual void logValue(std::string& strValue, CErrorContext& errorContext) const;
private:
// Get pending configuration
const CDomainConfiguration* getPendingConfiguration() const;
// Search for an applicable configuration
const CDomainConfiguration* findApplicableDomainConfiguration() const;
// Returns true if children dynamic creation is to be dealt with (here, will allow child deletion upon clean)
virtual bool childrenAreDynamic() const;
// Ensure validity on areas related to configurable element
void validateAreas(const CConfigurableElement* pConfigurableElement, const CParameterBlackboard* pMainBlackboard);
// Attempt validation for all configurable element's areas, relying on already existing valid configuration inside domain
void autoValidateAll();
// Attempt validation for one configurable element's areas, relying on already existing valid configuration inside domain
void autoValidateAreas(const CConfigurableElement* pConfigurableElement);
// Attempt configuration validation for all configurable elements' areas, relying on already existing valid configuration inside domain
bool autoValidateConfiguration(CDomainConfiguration* pDomainConfiguration);
// Search for a valid configuration for given configurable element
const CDomainConfiguration* findValidDomainConfiguration(const CConfigurableElement* pConfigurableElement) const;
// In case configurable element was removed
void computeSyncSet();
// Check configurable element already attached
bool containsConfigurableElement(const CConfigurableElement* pConfigurableCandidateElement) const;
// Merge any descended configurable element to this one
void mergeAlreadyAssociatedDescendantConfigurableElements(CConfigurableElement* pNewConfigurableElement);
void mergeConfigurations(CConfigurableElement* pToConfigurableElement, CConfigurableElement* pFromConfigurableElement);
// Configurable elements association
void doAddConfigurableElement(CConfigurableElement* pConfigurableElement, const CParameterBlackboard* pMainBlackboard = NULL);
void doRemoveConfigurableElement(CConfigurableElement* pConfigurableElement, bool bRecomputeSyncSet);
// XML parsing
/**
* Deserialize domain configurations from an Xml document and add them to
* the domain.
*
* @param[in] xmlElement the XML element to be parsed
* @param[in] serializingContext context for the deserialization
*
* @return false if an error occurs, true otherwise.
*/
bool parseDomainConfigurations(const CXmlElement& xmlElement,
CXmlDomainImportContext& serializingContext);
/**
* Deserialize domain elements from an Xml document and add them to
* the domain.
*
* @param[in] xmlElement the XML element to be parsed
* @param[in] serializingContext context for the deserialization
*
* @return false if an error occurs, true otherwise.
*/
bool parseConfigurableElements(const CXmlElement& xmlElement,
CXmlDomainImportContext& serializingContext);
/**
* Deserialize settings from an Xml document and add them to
* the domain.
*
* @param[in] xmlElement the XML element to be parsed
* @param[in] xmlDomainImportContext context for the deserialization
*
* @return false if an error occurs, true otherwise.
*/
bool parseSettings(const CXmlElement& xmlElement,
CXmlDomainImportContext& serializingContext);
// XML composing
void composeDomainConfigurations(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
void composeConfigurableElements(CXmlElement& xmlElement) const;
void composeSettings(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
// Syncer set retrieval from configurable element
CSyncerSet* getSyncerSet(const CConfigurableElement* pConfigurableElement) const;
// Configuration retrieval
CDomainConfiguration* findConfiguration(const std::string& strConfiguration, std::string& strError);
const CDomainConfiguration* findConfiguration(const std::string& strConfiguration, std::string& strError) const;
// Configurable elements
std::list<CConfigurableElement*> _configurableElementList;
// Associated syncer sets
std::map<const CConfigurableElement*, CSyncerSet*> _configurableElementToSyncerSetMap;
// Sequence awareness
bool _bSequenceAware;
// Syncer set used to ensure propoer synchronization of restored configurable elements
CSyncerSet _syncerSet;
// Last applied configuration
mutable const CDomainConfiguration* _pLastAppliedConfiguration;
};
|
