mINI::INIMap< T > Class Template Reference

INIMap class. More...

#include <ini.h>

Public Types
using	const_iterator = typename T_DataContainer::const_iterator
	Iterator for T_DataContainer.

Public Member Functions
	INIMap ()
	Constructor.
	INIMap (INIMap const &other)
	Constructor.
T &	operator[] (std::string key)
	Array item access operator.
T	get (std::string key) const
	Gets Value of Key.
bool	has (std::string key) const
	Check if Key exists.
void	set (std::string key, T obj)
	Adds or modificating an existing Key with value Obj.
void	set (T_MultiArgs const &multiArgs)
	Adds or modificating an existing Key with value Obj.
bool	remove (std::string key)
	Remove Key and its value from dataIndexMap.
void	clear ()
	Clears all the data.
std::size_t	size () const
	Returns number of pairs.
const_iterator	begin () const
	Points the beginning item of data.
const_iterator	end () const
	Points the last item of data.

Detailed Description

template<typename T>
class mINI::INIMap< T >

INIMap class.

Template Parameters

T

Constructor & Destructor Documentation

INIMap()

template<typename T >

mINI::INIMap< T >::INIMap ( INIMap< T > const & other )

inline

Constructor.

Parameters

other

Source data to copy

Member Function Documentation

begin()

template<typename T >

const_iterator mINI::INIMap< T >::begin ( ) const

inline

Points the beginning item of data.

Returns

Iterator of last item

end()

template<typename T >

const_iterator mINI::INIMap< T >::end ( ) const

inline

Points the last item of data.

Returns

Iterator of last item

get()

template<typename T >

T mINI::INIMap< T >::get ( std::string key ) const

inline

Gets Value of Key.

Parameters

key	Key to search the Value

Returns

Value of Key

has()

template<typename T >

bool mINI::INIMap< T >::has ( std::string key ) const

inline

Check if Key exists.

Parameters

key	Key to check

Returns

true if key was found, false otherwise

operator[]()

template<typename T >

T & mINI::INIMap< T >::operator[] ( std::string key )

inline

Array item access operator.

Parameters

[in]

key

Item key, that should be accessed

Returns

Value of Key

remove()

template<typename T >

bool mINI::INIMap< T >::remove ( std::string key )

inline

Remove Key and its value from dataIndexMap.

Parameters

key	Key of pair to remove

Returns

true if succeed, false otherwise

set() [1/2]

template<typename T >

void mINI::INIMap< T >::set ( std::string key, T obj )

inline

Adds or modificating an existing Key with value Obj.

Parameters

key	Key to add or modificate its value
obj	Obj to assign with a key

set() [2/2]

template<typename T >

void mINI::INIMap< T >::set ( T_MultiArgs const & multiArgs )

inline

Adds or modificating an existing Key with value Obj.

Parameters

multiArgs

Array of pair of Key,Value

size()

template<typename T >

std::size_t mINI::INIMap< T >::size ( ) const

inline

Returns number of pairs.

Returns

Number of data pairs

---

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

• inc/ini.h