ripple::LedgerFormats Class Reference

Holds the list of known ledger entry formats. More...

#include <LedgerFormats.h>

Inheritance diagram for ripple::LedgerFormats:

Collaboration diagram for ripple::LedgerFormats:

Public Member Functions
LedgerEntryType	findTypeByName (std::string const &name) const
	Retrieve the type for a format specified by name.
Item const *	findByType (LedgerEntryType type) const
	Retrieve a format based on its type.
std::forward_list< Item >::const_iterator	begin () const
std::forward_list< Item >::const_iterator	end () const

Static Public Member Functions
static LedgerFormats const &	getInstance ()

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

Private Member Functions
	LedgerFormats ()
	Create the object.

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

Detailed Description

Holds the list of known ledger entry formats.

Definition at line 214 of file LedgerFormats.h.

Constructor & Destructor Documentation

LedgerFormats()

ripple::LedgerFormats::LedgerFormats ( )

private

Create the object.

This will load the object with all the known ledger formats.

Definition at line 29 of file LedgerFormats.cpp.

Member Function Documentation

getInstance()

LedgerFormats const & ripple::LedgerFormats::getInstance ( )

static

Definition at line 56 of file LedgerFormats.cpp.

findTypeByName()

LedgerEntryType ripple::KnownFormats< LedgerEntryType , LedgerFormats >::findTypeByName ( std::string const &  name ) const

inherited

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 117 of file KnownFormats.h.

findByType()

Item const * ripple::KnownFormats< LedgerEntryType , LedgerFormats >::findByType ( LedgerEntryType  type ) const

inherited

Retrieve a format based on its type.

Definition at line 129 of file KnownFormats.h.

begin()

std::forward_list< Item >::const_iterator ripple::KnownFormats< LedgerEntryType , LedgerFormats >::begin ( ) const

inherited

Definition at line 139 of file KnownFormats.h.

end()

std::forward_list< Item >::const_iterator ripple::KnownFormats< LedgerEntryType , LedgerFormats >::end ( ) const

inherited

Definition at line 145 of file KnownFormats.h.

findByName()

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

protectedinherited

Retrieve a format based on its name.

Definition at line 154 of file KnownFormats.h.

add()

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

protectedinherited

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 172 of file KnownFormats.h.

Member Data Documentation

name_

std::string ripple::KnownFormats< LedgerEntryType , LedgerFormats >::name_

privateinherited

Definition at line 194 of file KnownFormats.h.

formats_

std::forward_list<Item> ripple::KnownFormats< LedgerEntryType , LedgerFormats >::formats_

privateinherited

Definition at line 199 of file KnownFormats.h.

names_

boost::container::flat_map<std::string, Item const*> ripple::KnownFormats< LedgerEntryType , LedgerFormats >::names_

privateinherited

Definition at line 201 of file KnownFormats.h.

types_

boost::container::flat_map<LedgerEntryType , Item const*> ripple::KnownFormats< LedgerEntryType , LedgerFormats >::types_

privateinherited

Definition at line 202 of file KnownFormats.h.