EnumDict< E, OWNER > Struct Template Reference

A container for a static dictionary of enumeration values. More...

#include <EnumFlags.h>

Collaboration diagram for EnumDict< E, OWNER >:

Public Types
typedef drain::Dictionary< std::string, E >	dict_t

Public Member Functions
const drain::FlagResolver::dict_t	dict
	const drain::FlaggerBase<Crit>::dict_t CritFlagger::dict = {{"DATA", DATA}, {"ELANGLE", ELANGLE}, {"TIME", TIME}};
const drain::FlagResolver::dict_t	dict
const drain::FlagResolver::dict_t	dict
const drain::EnumDict< DataOrder::Crit >::dict_t	dict
	const drain::FlaggerBase<Crit>::dict_t CritFlagger::dict = {{"DATA", DATA}, {"ELANGLE", ELANGLE}, {"TIME", TIME}};
const drain::EnumDict< DataOrder::Oper >::dict_t	dict
const drain::EnumDict< DataSelector::Prf >::dict_t	dict
const drain::EnumDict< rack::ODIM::Version >::dict_t	dict
const drain::EnumDict< ProductConf::OutputDataVerbosity >::dict_t	dict
const drain::EnumDict< ProductConf::OutputDataVerbosity >::dict_t	dict
const drain::EnumDict< AlignBase::Axis >::dict_t	dict
const drain::EnumDict< AlignBase::Pos >::dict_t	dict
const drain::EnumDict< AlignSVG::HorzAlign >::dict_t	dict
	Dictionary of horizontal (LEFT,CENTER,RIGHT) flags.
const drain::EnumDict< AlignSVG::VertAlign >::dict_t	dict
	Dictionary of vertical (TOP,MIDDLE,BOTTOM) flags.
const drain::EnumDict< FileGeoTIFF::TiffCompliance >::dict_t	dict
const EnumDict< image::SLD::tag_t >::dict_t	dict
const EnumDict< image::SLD::tag_t >::dict_t	dict
const drain::EnumDict< NodeGDAL::tag_t >::dict_t	dict
const EnumDict< image::NodeGDAL::tag_t >::dict_t	dict
const drain::EnumDict< Projector::PROJDEF_variant >::dict_t	dict
const drain::EnumDict< Projector::PROJDEF_variant >::dict_t	dict
const drain::EnumDict< Status >::dict_t	dict
const drain::EnumDict< Status >::dict_t	dict
const drain::EnumDict< TextStyle::Style >::dict_t	dict
const drain::EnumDict< TextStyle::Colour >::dict_t	dict
const drain::EnumDict< TextStyle::Line >::dict_t	dict
const drain::EnumDict< Html::tag_t >::dict_t	dict
const drain::EnumDict< Html::tag_t >::dict_t	dict
const drain::EnumDict< int, XML >::dict_t	dict
const drain::EnumDict< int, XML >::dict_t	dict
	XML output function shared for all XML documents, ie versions defined in subclasses.
const drain::EnumDict< XML::entity_t >::dict_t	dict
const drain::EnumDict< XML::entity_t >::dict_t	dict
const drain::EnumDict< Reader::Mode >::dict_t	dict
const drain::EnumDict< hi5::Reader::Mode >::dict_t	dict
const drain::EnumDict< Hdf5Context::Hi5Role >::dict_t	dict
const drain::EnumDict< Hdf5Context::Hi5RoleFlagger >::dict_t	dict
const drain::EnumDict< rack::SvgInclude >::dict_t	dict
const drain::EnumDict< rack::PanelConfSVG::ElemClass >::dict_t	dict
const drain::EnumDict< rack::PanelConfSVG::PathPolicy >::dict_t	dict
const drain::EnumDict< rack::SvgInclude >::dict_t	dict
const drain::EnumDict< rack::PanelConfSVG::ElemClass >::dict_t	dict
const drain::EnumDict< rack::PanelConfSVG::PathPolicy >::dict_t	dict

Static Public Member Functions
static const dict_t &	getDict ()
static const std::string &	str (const E &value)
	Convenience.
static bool	setValue (const std::string &key, E &value)
	Assign string values to an enumeration type.
static E	getValue (const E &value, bool lenient=true)
	Convenience for object.set(...) like commands.
static E	getValue (const std::string &key, bool lenient=true)
	Convenience for object.set(...) like commands.
static E	getValue (const char *key, bool lenient=true)
	Convenience for object.set(...) like commands.
static const std::string &	getKey (const std::string &s, bool lenient=true)
	Convenience for object.set(...) like commands.
static const char *	getKey (const char *s, bool lenient=true)
static const std::string &	getKey (const E &value, bool lenient=true)

Static Public Attributes
static const dict_t	dict

Detailed Description

template<class E, class OWNER = E>
struct drain::EnumDict< E, OWNER >

A container for a static dictionary of enumeration values.

DrainCore

Template Parameters

E	- enumeration or integer type
OWNER	- identifier type (separate type, typically a class, can be used if several dictionaries needed for the same enumeration type)

Template is needed to create a unique, shared (static) dict object for each template.

Member Function Documentation

dict() [1/2]

const drain::EnumDict< int, XML >::dict_t dict

XML output function shared for all XML documents, ie versions defined in subclasses.

TODO: preamble/prologToStream()

Parameters

defaultTag

- important for

dict() [2/2]

const drain::EnumDict< XML::entity_t >::dict_t dict

https://www.w3schools.com/charsets/ref_utf_basic_latin.asp

getKey()

template<class E , class OWNER = E>

static const std::string & getKey ( const std::string &  s, bool  lenient = true  )

inlinestatic

Convenience for object.set(...) like commands.

 \return enum value of the key

 Note: cannot return (const E &) as storage type is (long) int.

static inline E getKey(const E & value, bool lenient=true){ return value; } Experimental. Convenience for object.set(...) like commands.

Parameters

lenient

- when key not found, only return empty, do not throw exception.

Returns

enum value of the key

getValue() [1/3]

template<class E , class OWNER = E>

static E getValue ( const char *  key, bool  lenient = true  )

inlinestatic

Convenience for object.set(...) like commands.

Parameters

lenient

- when value not found, only return empty, do not throw exception.

Returns

enum value of the key

getValue() [2/3]

template<class E , class OWNER = E>

static E getValue ( const E &  value, bool  lenient = true  )

inlinestatic

Convenience for object.set(...) like commands.

Returns

enum value of the key

Note: cannot return (const E &) as storage type is (long) int.

getValue() [3/3]

template<class E , class OWNER = E>

static E getValue ( const std::string &  key, bool  lenient = true  )

inlinestatic

Convenience for object.set(...) like commands.

Parameters

lenient

- when key not found, only return empty, do not throw exception.

Returns

enum value of the key

setValue()

template<class E , class OWNER = E>

static bool setValue ( const std::string &  key, E &  value  )

inlinestatic

Assign string values to an enumeration type.

Template Parameters

E	- some enumeration type for which Dictionary dict has been defined.

---

The documentation for this struct was generated from the following file:

• src/drain/util/EnumFlags.h