mnx::Dictionary< T > Class Template Reference

Represents an MNX dictionary, where each key is a user-defined string. More...

#include <BaseTypes.h>

Inheritance diagram for mnx::Dictionary< T >:

Public Types
using	value_type = T
	The type for elements in this Array.
using	iterator = iter< Dictionary, json::iterator >
	non-const iterator type
using	const_iterator = iter< const Dictionary, json::const_iterator >
	const iterator type

Public Member Functions
	Dictionary (const std::shared_ptr< json > &root, json_pointer pointer)
	Wraps an Dictionary class around an existing JSON node.
	Dictionary (Base &parent, std::string_view key)
	Creates a new Dictionary class as a child of a JSON node.
size_t	size () const
	Get the size of the array.
bool	empty () const
	Check if the array is empty.
void	clear ()
	Clear all elements.
T	at (size_t index) const
	Direct getter for a particular element.
auto	operator[] (const std::string &key) const
	const operator[]
auto	operator[] (const std::string &key)
	non-const operator[]
template<typename U = T>
std::enable_if_t<!std::is_base_of_v< Base, U >, void >	emplace (const std::string &key, const U &value)
	Add a new value to the dictonary. (Available only for primitive types)
template<typename U = T, typename... Args, std::enable_if_t< std::is_base_of_v< Base, U >, int > = 0>
U	append (const std::string &key, Args &&... args)
	Create a new element using the input key. (Available only for Base types)
void	erase (const std::string &key)
	Remove an element at a given key.
auto	find (const std::string &key)
	Finds an element by key and returns an iterator.
auto	find (const std::string &key) const
	Finds an element by key and returns a const iterator.
bool	contains (const std::string &key) const
	Returns true if the key exists in in the dictionary.
auto	begin ()
	Returns an iterator to the beginning of the dictionary.
auto	end ()
	Returns an iterator to the end of the dictionary.
auto	begin () const
	Returns a const iterator to the beginning of the dictionary.
auto	end () const
	Returns a const iterator to the end of the dictionary.
Public Member Functions inherited from mnx::Object
	Object (const std::shared_ptr< json > &root, json_pointer pointer)
	Wraps an Object class around an existing JSON object node.
	Object (Base &parent, std::string_view key)
	Creates a new Object class as a child of a JSON node.
	MNX_OPTIONAL_PROPERTY (std::string, _c)
	An optional comment. This serves a similar function as XML or HTML comments.
	MNX_OPTIONAL_CHILD (Object, _x)
	Vendor-defined dictionary.
	MNX_OPTIONAL_PROPERTY (std::string, id)
	Uniquely identifies the object.
Public Member Functions inherited from mnx::Base
	Base (const Base &src)
	Copy constructor.
	Base (Base &&src) noexcept
	Move constructor.
Base &	operator= (const Base &src)
	Copy assignment operator.
Base &	operator= (Base &&src)
	Move assignment operator.
std::string	dump (int indents=-1) const
	Dumps the branch to a string. Useful in debugging.
template<typename T >
T	parent () const
	Returns the parent object for this node.
template<typename T >
std::optional< T >	getEnclosingElement () const
	Returns the enclosing array element for this instance. If T is a type that can be nested (e.g. ContentObject), the highest level instance is returned. (To get the lowest level immediate container, use ArrayElementObject::container.)
json_pointer	pointer () const
	Returns the json_pointer for this node.
Document	document () const
	Returns the document root.

Additional Inherited Members
Protected Member Functions inherited from mnx::Base
json &	ref () const
	Convert this node for retrieval.
json &	ref ()
	Access the JSON node for modification.
const std::shared_ptr< json > &	root () const
	Returns the root.
	Base (const std::shared_ptr< json > &root, json_pointer pointer)
	Wrap a Base instance around a specific JSON reference using a json_pointer.
	Base (json &&jsonRef, Base &parent, std::string_view key)
	Construct a Base reference as a child inside a parent node.
template<typename T >
T	getChild (std::string_view key) const
	Retrieves and validates a required child node.
template<typename T >
T	setChild (std::string_view key, const T &value)
	Sets a child node.
template<typename T >
std::optional< T >	getOptionalChild (std::string_view key) const
	Retrieves an optional child node.

Detailed Description

template<typename T>
class mnx::Dictionary< T >

Represents an MNX dictionary, where each key is a user-defined string.

Constructor & Destructor Documentation

Dictionary() [1/2]

template<typename T >

mnx::Dictionary< T >::Dictionary ( const std::shared_ptr< json > &  root, json_pointer  pointer  )

inline

Wraps an Dictionary class around an existing JSON node.

Parameters

root	Reference to the document root
pointer	The json_pointer value for the node

Dictionary() [2/2]

template<typename T >

mnx::Dictionary< T >::Dictionary ( Base &  parent, std::string_view  key  )

inline

Creates a new Dictionary class as a child of a JSON node.

Parameters

parent	The parent class instance
key	The JSON key to use for embedding in parent.

Member Function Documentation

append()

template<typename T >

template<typename U = T, typename... Args, std::enable_if_t< std::is_base_of_v< Base, U >, int > = 0>

U mnx::Dictionary< T >::append ( const std::string &  key, Args &&...  args  )

inline

Create a new element using the input key. (Available only for Base types)

Returns

The newly created element.

contains()

template<typename T >

bool mnx::Dictionary< T >::contains ( const std::string &  key ) const

inline

Returns true if the key exists in in the dictionary.

Parameters

key	The key to search for.

find() [1/2]

template<typename T >

auto mnx::Dictionary< T >::find ( const std::string &  key )

inline

Finds an element by key and returns an iterator.

Parameters

key	The key to search for.

Returns

Iterator to the found element or end() if not found.

find() [2/2]

template<typename T >

auto mnx::Dictionary< T >::find ( const std::string &  key ) const

inline

Finds an element by key and returns a const iterator.

Parameters

key	The key to search for.

Returns

Const iterator to the found element or end() if not found.