#include <ddenum.h>

Inherits ddl::DDEnum.

Public Member Functions
	DDEnumGenerator (const std::string &name, const std::vector< std::pair< std::string, EnumDataType > > elements={})
	CTOR.

DDEnumGenerator &	addElement (const std::string &name, EnumDataType value)
	Adds a element for the enumeration with name and value.

Public Member Functions inherited from ddl::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.

DDEnum &	operator= (const DDEnum &other)
	copies a DDEnum object

	DDEnum (const std::string &name, const dd::DataType &data_type, const std::vector< dd::EnumType::Element > &elements={})
	Construct a new DDEnum object.

	DDEnum (const std::string &name, const DDDataType &data_type, const std::vector< dd::EnumType::Element > &elements={})
	Construct a new DDEnum object.

DDEnum &	addElement (const dd::EnumType::Element &element)
	adds a EnumType element.

DDEnum &	addElement (const std::string &name, int64_t value)
	adds a EnumType element.

DDEnum &	addElements (const std::vector< dd::EnumType::Element > &elements)
	adds a vector of EnumType elements.

const dd::EnumType &	getEnumType () const
	Get the Enum Type object.

const dd::DataDefinition &	getDD () const
	return the valid data definition.

size_t	getTypeByteSize () const
	returns the size of the underlying datatype.

size_t	getAlignment () const
	returns the alignment of the underlying datatype.

Detailed Description

template<typename EnumDataType, typename Enable = void>
class ddl::DDEnumGenerator< EnumDataType, Enable >

This is used to create the DD representation of an enumeration type.

Example Usages

enum MyEnum : uint8_t {eA, eB};
auto my_enum_type = DDEnumGenerator<MyEnum>("MyEnum")
                       .addElement("eA", eA)
                       .addElement("eB", eB);

Template Parameters

EnumDataType	The type of the enum .
Enable	type trait

Constructor & Destructor Documentation

◆ DDEnumGenerator()

template<typename EnumDataType, typename Enable = void>

ddl::DDEnumGenerator< EnumDataType, Enable >::DDEnumGenerator	(	const std::string &	name,
		const std::vector< std::pair< std::string, EnumDataType > >	elements = {} )

inline

CTOR.

Parameters

name	the name of the enum for DataDefinition
elements	the elements of the enumeration

Member Function Documentation

◆ addElement()