blob: 6353e2dd1122451f1a3dcc52e434615e36522740 (
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
|
#pragma once
#include "section_header.hpp"
#include <optional>
namespace openpower
{
namespace pels
{
/**
* @class Section
*
* The base class for a PEL section. It contains the SectionHeader
* as all sections start with it.
*
*/
class Section
{
public:
Section() = default;
virtual ~Section() = default;
Section(const Section&) = default;
Section& operator=(const Section&) = default;
Section(Section&&) = default;
Section& operator=(Section&&) = default;
/**
* @brief Returns a reference to the SectionHeader
*/
const SectionHeader& header() const
{
return _header;
}
/**
* @brief Says if the section is valid.
*/
bool valid() const
{
return _valid;
}
/**
* @brief Flatten the section into the stream
*
* @param[in] stream - The stream to write to
*/
virtual void flatten(Stream& stream) const = 0;
/**
* @brief Get section in JSON. Derived classes to override when required to.
* @return std::optional<std::string> - If a section comes with a JSON
* repressentation, this would return the string for it.
*/
virtual std::optional<std::string> getJSON() const
{
return std::nullopt;
}
protected:
/**
* @brief Returns the flattened size of the section header
*/
static constexpr size_t flattenedSize()
{
return SectionHeader::flattenedSize();
}
/**
* @brief Used to validate the section.
*
* Implemented by derived classes.
*/
virtual void validate() = 0;
/**
* @brief The section header structure.
*
* Filled in by derived classes.
*/
SectionHeader _header;
/**
* @brief The section valid flag.
*
* This is determined by the derived class.
*/
bool _valid = false;
};
} // namespace pels
} // namespace openpower
|
