enumeration< Type >
This is used to create an enumeration ytpe from an existing c++ enum. More...
Inheritance diagram for enumeration< Type >:
Public Types | |
| typedef ddl::DDEnumGenerator< Type > | base_type |
Public Member Functions | |
| enumeration (const std::string &strName) | |
| size_t | GetSize () const |
| Returns the size of the enumeration and underlying data type. More... | |
| size_t | GetAlignment () const |
| Returns the alignment of the enumeration and underlying data type. More... | |
| enumeration & | Add (const std::string &strName, Type eValue) |
| Adds a new mapped value to the enumeration. More... | |
 Public Member Functions inherited from DDEnumGenerator< Type > | |
| DDEnumGenerator (const std::string &name, const std::vector< std::pair< std::string, Type >> elements={}) | |
| CTOR. More... | |
| DDEnumGenerator & | addElement (const std::string &name, Type value) |
| Adds a element for the enumeration with name and value. More... | |
| Public Member Functions inherited from DDEnum | |
| DDEnum ()=delete | |
| Construct a new DDEnum object. | |
| DDEnum (DDEnum &&) | |
| Construct a new DDEnum object. | |
| DDEnum & | operator= (DDEnum &&) |
| DDEnum (const DDEnum &other) | |
| Construct a new DDEnum object. More... | |
| DDEnum & | operator= (const DDEnum &other) |
| copies a DDEnum object More... | |
| DDEnum (const std::string &name, const dd::DataType &data_type, const std::vector< dd::EnumType::Element > &elements={}) | |
| Construct a new DDEnum object. More... | |
| DDEnum (const std::string &name, const DDDataType &data_type, const std::vector< dd::EnumType::Element > &elements={}) | |
| Construct a new DDEnum object. More... | |
| DDEnum & | addElement (const dd::EnumType::Element &element) |
| adds a EnumType element. More... | |
| DDEnum & | addElement (const std::string &name, int64_t value) |
| adds a EnumType element. More... | |
| DDEnum & | addElements (const std::vector< dd::EnumType::Element > &elements) |
| adds a vector of EnumType elements. More... | |
| const dd::EnumType & | getEnumType () const |
| Get the Enum Type object. More... | |
| const dd::DataDefinition & | getDD () const |
| return the valid data definition. More... | |
| size_t | getAlignment () const |
| returns the alignment of the underlying data type. More... | |
Detailed Description
template<typename Type>
class adtf::mediadescription::osborn::enumeration< Type >
This is used to create an enumeration ytpe from an existing c++ enum.
Example Usage
enum tMyEnum
{
eA = 0,
eB = 1
};
//possibility 1
auto oMyEnumType = enumeration<tMyEnum>("tMyEnum")
.Add("eA", eA)
.Add("eB", eB);
//possibility 2
auto oMyEnumType = enumeration<uint8_t>("tMyEnum")
.Add("eA", 0)
.Add("eB", 1);
Definition at line 49 of file type_reflection.h.
Constructor & Destructor Documentation
◆ enumeration()
|
inline |
- Parameters
-
[in] strName The name of the enumeration.
Definition at line 57 of file type_reflection.h.
Member Function Documentation
◆ Add()
|
inline |
Adds a new mapped value to the enumeration.
- Parameters
-
[in] strName The name of the value. [in] eValue The value.
- Returns
- A reference to the enumeration.
Definition at line 86 of file type_reflection.h.
References DDEnumGenerator< Type >::addElement().
◆ GetAlignment()
|
inline |
Returns the alignment of the enumeration and underlying data type.
- Returns
- size_t The alignment
Definition at line 75 of file type_reflection.h.
References DDEnum::getEnumType().
◆ GetSize()
|
inline |
Returns the size of the enumeration and underlying data type.
- Returns
- size_t The size in bytes
Definition at line 66 of file type_reflection.h.
References DDEnum::getEnumType().