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
|
/*
* 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 "ConfigurableElement.h"
#include "Mapper.h"
#include "MappingContext.h"
#include <stack>
#include <vector>
class CInstanceDefinition;
class CComponentLibrary;
class CSubsystemObject;
class CSubsystemObjectCreator;
class CSubsystem : public CConfigurableElement, private IMapper
{
// Subsystem objects iterator
typedef list<CSubsystemObject*>::const_iterator SubsystemObjectListIterator;
public:
CSubsystem(const string& strName);
virtual ~CSubsystem();
// From IXmlSink
virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
// Susbsystem Endianness
bool isBigEndian() const;
// Susbsystem sanity
virtual bool isAlive() const;
// Resynchronization after subsystem restart needed
virtual bool needResync(bool bClear);
// XML configuration settings parsing
virtual bool serializeXmlSettings(CXmlElement& xmlConfigurationSettingsElementContent, CConfigurationAccessContext& configurationAccessContext) const;
// from CElement
virtual string getKind() const;
protected:
// Parameter access
virtual bool accessValue(CPathNavigator& pathNavigator, string& strValue, bool bSet, CParameterAccessContext& parameterAccessContext) const;
virtual void logValue(string& strValue, CErrorContext& errorContext) const;
// Used for simulation and virtual subsystems
virtual void setDefaultValues(CParameterAccessContext& parameterAccessContext) const;
/// Functionality intendedn for derived Subsystems
// Subsystem context mapping keys publication
void addContextMappingKey(const string& strMappingKey);
// Subsystem object creator publication (strong reference)
void addSubsystemObjectFactory(CSubsystemObjectCreator* pSubsystemObjectCreator);
private:
CSubsystem(const CSubsystem&);
CSubsystem& operator=(const CSubsystem&);
// Belonging subsystem
virtual const CSubsystem* getBelongingSubsystem() const;
// Mapping execution
bool mapSubsystemElements(string& strError);
/**
* Generic subsystem mapping error handling
*
* Format an human readable error string from a key and a message in case of mapping error
*
* @param[out] strError The formated error string
* @param[in] strKey The key on which the error refers
* @param[in] strMessage The error message
* @param[in] pInstanceConfigurableElement The element on wich the error refers
*/
void getMappingError(string& strError, const string& strKey, const string& strMessage,
const CInstanceConfigurableElement* pInstanceConfigurableElement);
/**
* Handle a configurable element mapping.
*
* Add context mappings to the context and instantiate a subsystem object if needed.
*
* @param[in:out] pInstanceConfigurableElement The configurable element
* @param[out] bKeepDiving Keep diving for mapping keys
Is set to true if a subsystem object (tree leave) has been instantiated.
Undetermined on error
* @param[out] strError String filled with an human readable error on error,
left unmodified otherwise
*
* @return true on success, false on failure
*/
virtual bool mapBegin(CInstanceConfigurableElement* pInstanceConfigurableElement, bool& bKeepDiving, string& strError);
virtual void mapEnd();
// Mapping generic context handling
bool handleMappingContext(const CInstanceConfigurableElement* pInstanceConfigurableElement, CMappingContext& context, string& strError);
/**
* Looks if a subsystem object needs to be instantiated for the given configurable
* element, then instantiate it if needed.
*
* @param[in:out] pInstanceConfigurableElement The configurable element to check
* for instanciation
* @param[in] context The mapping values container
* @param[out] bHasCreatedSubsystemObject If a subsystem object has been instantiated.
Undetermined on error
* @param[out] strError String filled with an human readable error on error,
left unmodified otherwise
*
* @return true on success, false on failure
*/
bool handleSubsystemObjectCreation(CInstanceConfigurableElement* pInstanceConfigurableElement,
CMappingContext& context, bool& bHasCreatedSubsystemObject, string& strError);
// Subsystem context mapping keys
vector<string> _contextMappingKeyArray;
// Subsystem object creator map
vector<CSubsystemObjectCreator*> _subsystemObjectCreatorArray;
// Subsystem sync objects (house keeping)
list<CSubsystemObject*> _subsystemObjectList;
// Mapping Context stack
stack<CMappingContext> _contextStack;
// Subelements
CComponentLibrary* _pComponentLibrary;
CInstanceDefinition* _pInstanceDefinition;
// Endianness
bool _bBigEndian;
};
|
