ripple::KnownFormats< KeyType, Derived > Class Template Reference

Manages a list of known formats. More...

Collaboration diagram for ripple::KnownFormats< KeyType, Derived >:

Classes
class	Item
	A known format. More...

Public Member Functions
	KnownFormats ()
	Create the known formats object. More...
virtual	~KnownFormats ()=default
	Destroy the known formats object. More...
	KnownFormats (KnownFormats const &)=delete
KnownFormats &	operator= (KnownFormats const &)=delete
KeyType	findTypeByName (std::string const &name) const
	Retrieve the type for a format specified by name. More...
Item const *	findByType (KeyType type) const
	Retrieve a format based on its type. More...
std::forward_list< Item >::const_iterator	begin () const
std::forward_list< Item >::const_iterator	end () const

Protected Member Functions
Item const *	findByName (std::string const &name) const
	Retrieve a format based on its name. More...
Item const &	add (char const *name, KeyType type, std::initializer_list< SOElement > uniqueFields, std::initializer_list< SOElement > commonFields={})
	Add a new format. More...

Private Attributes
std::string	name_
std::forward_list< Item >	formats_
boost::container::flat_map< std::string, Item const * >	names_
boost::container::flat_map< KeyType, Item const * >	types_

Detailed Description

template<class KeyType, class Derived>
class ripple::KnownFormats< KeyType, Derived >

Manages a list of known formats.

Each format has a name, an associated KeyType (typically an enumeration), and a predefined SOElement.

Template Parameters

KeyType

The type of key identifying the format.

Definition at line 40 of file KnownFormats.h.

Constructor & Destructor Documentation

KnownFormats() [1/2]

template<class KeyType , class Derived >

ripple::KnownFormats< KeyType, Derived >::KnownFormats

(

)

Create the known formats object.

Derived classes will load the object with all the known formats.

Definition at line 94 of file KnownFormats.h.

~KnownFormats()

template<class KeyType , class Derived >

virtual ripple::KnownFormats< KeyType, Derived >::~KnownFormats ( )

virtualdefault

Destroy the known formats object.

The defined formats are deleted.

KnownFormats() [2/2]

template<class KeyType , class Derived >

ripple::KnownFormats< KeyType, Derived >::KnownFormats ( KnownFormats< KeyType, Derived > const &  )

delete

Member Function Documentation

operator=()

template<class KeyType , class Derived >

KnownFormats& ripple::KnownFormats< KeyType, Derived >::operator= ( KnownFormats< KeyType, Derived > const &  )

delete

findTypeByName()

template<class KeyType , class Derived >

KeyType ripple::KnownFormats< KeyType, Derived >::findTypeByName

(

std::string const &

name

)

const

Retrieve the type for a format specified by name.

If the format name is unknown, an exception is thrown.

Parameters

name	The name of the type.

Returns

The type.

Definition at line 115 of file KnownFormats.h.

findByType()

template<class KeyType , class Derived >

Item const* ripple::KnownFormats< KeyType, Derived >::findByType

(

KeyType

type

)

const

Retrieve a format based on its type.

Definition at line 127 of file KnownFormats.h.

begin()

template<class KeyType , class Derived >

std::forward_list<Item>::const_iterator ripple::KnownFormats< KeyType, Derived >::begin

(

)

const

Definition at line 137 of file KnownFormats.h.

end()

template<class KeyType , class Derived >

std::forward_list<Item>::const_iterator ripple::KnownFormats< KeyType, Derived >::end

(

)

const

Definition at line 143 of file KnownFormats.h.

findByName()

template<class KeyType , class Derived >

Item const* ripple::KnownFormats< KeyType, Derived >::findByName ( std::string const &  name ) const

protected

Retrieve a format based on its name.

Definition at line 152 of file KnownFormats.h.

add()

template<class KeyType , class Derived >

Item const& ripple::KnownFormats< KeyType, Derived >::add ( char const *  name, KeyType  type, std::initializer_list< SOElement >  uniqueFields, std::initializer_list< SOElement >  commonFields = {}  )

protected

Add a new format.

Parameters

name	The name of this format.
type	The type of this format.
uniqueFields	An std::initializer_list of unique fields
commonFields	An std::initializer_list of common fields

Returns

The created format.

Definition at line 170 of file KnownFormats.h.

Member Data Documentation

name_

template<class KeyType , class Derived >

std::string ripple::KnownFormats< KeyType, Derived >::name_

private

Definition at line 192 of file KnownFormats.h.

formats_

template<class KeyType , class Derived >

std::forward_list<Item> ripple::KnownFormats< KeyType, Derived >::formats_

private

Definition at line 197 of file KnownFormats.h.

names_

template<class KeyType , class Derived >

boost::container::flat_map<std::string, Item const*> ripple::KnownFormats< KeyType, Derived >::names_

private

Definition at line 199 of file KnownFormats.h.

types_

template<class KeyType , class Derived >

boost::container::flat_map<KeyType, Item const*> ripple::KnownFormats< KeyType, Derived >::types_

private

Definition at line 200 of file KnownFormats.h.