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
|
/*
* INTEL CONFIDENTIAL
* Copyright © 2011 Intel
* Corporation All Rights Reserved.
*
* The source code contained or described herein and all documents related to
* the source code ("Material") are owned by Intel Corporation or its suppliers
* or licensors. Title to the Material remains with Intel Corporation or its
* suppliers and licensors. The Material contains trade secrets and proprietary
* and confidential information of Intel or its suppliers and licensors. The
* Material is protected by worldwide copyright and trade secret laws and
* treaty provisions. No part of the Material may be used, copied, reproduced,
* modified, published, uploaded, posted, transmitted, distributed, or
* disclosed in any way without Intel’s prior express written permission.
*
* No license under any patent, copyright, trade secret or other intellectual
* property right is granted to or conferred upon you by disclosure or delivery
* of the Materials, either expressly, by implication, inducement, estoppel or
* otherwise. Any license under such intellectual property rights must be
* express and approved by Intel in writing.
*
* CREATED: 2011-06-01
* UPDATED: 2011-07-27
*/
#pragma once
#include "BinarySerializableElement.h"
#include "SyncerSet.h"
#include <list>
#include <set>
#include <map>
class CConfigurableElement;
class CDomainConfiguration;
class CParameterBlackboard;
class CSelectionCriteriaDefinition;
class CConfigurableDomain : public CBinarySerializableElement
{
typedef list<CConfigurableElement*>::const_iterator ConfigurableElementListIterator;
typedef map<const CConfigurableElement*, CSyncerSet*>::const_iterator ConfigurableElementToSyncerSetMapIterator;
public:
CConfigurableDomain(const string& strName);
virtual ~CConfigurableDomain();
// Sequence awareness
void setSequenceAwareness(bool bSequenceAware);
bool getSequenceAwareness() const;
// Configuration Management
bool createConfiguration(const string& strName, const CParameterBlackboard* pMainBlackboard, string& strError);
bool deleteConfiguration(const string& strName, string& strError);
bool renameConfiguration(const string& strName, const string& strNewName, string& strError);
bool restoreConfiguration(const string& strName, CParameterBlackboard* pMainBlackboard, bool bAutoSync, string& strError) const;
bool saveConfiguration(const string& strName, const CParameterBlackboard* pMainBlackboard, string& strError);
bool setElementSequence(const string& strConfiguration, const vector<string>& astrNewElementSequence, string& strError);
bool getElementSequence(const string& strConfiguration, string& strResult) const;
bool setApplicationRule(const string& strConfiguration, const string& strApplicationRule, const CSelectionCriteriaDefinition* pSelectionCriteriaDefinition, string& strError);
bool clearApplicationRule(const string& strConfiguration, string& strError);
bool getApplicationRule(const string& strConfiguration, string& strResult) const;
// Last applied configuration name
string getLastAppliedConfigurationName() const;
// Pending configuration name
string getPendingConfigurationName() const;
// Associated Configurable elements
void gatherConfigurableElements(set<const CConfigurableElement*>& configurableElementSet) const;
void listAssociatedToElements(string& strResult) const;
// Configurable elements association
bool addConfigurableElement(CConfigurableElement* pConfigurableElement, const CParameterBlackboard* pMainBlackboard, string& strError);
bool removeConfigurableElement(CConfigurableElement* pConfigurableElement, string& strError);
// Domain splitting
bool split(CConfigurableElement* pConfigurableElement, string& strError);
// Ensure validity on whole domain from main blackboard
void validate(const CParameterBlackboard* pMainBlackboard);
// Configuration application if required
bool apply(CParameterBlackboard* pParameterBlackboard, CSyncerSet& syncerSet, bool bForced, string& strError) 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;
// Class kind
virtual string getKind() const;
protected:
// Content dumping
virtual void logValue(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
bool parseDomainConfigurations(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
bool parseConfigurableElements(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
bool parseSettings(const CXmlElement& xmlElement, CXmlSerializingContext& 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 string& strConfiguration, string& strError);
const CDomainConfiguration* findConfiguration(const string& strConfiguration, string& strError) const;
// Configurable elements
list<CConfigurableElement*> _configurableElementList;
// Associated syncer sets
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;
};
|
