TextInterface::MapOfInterfaces< M, K, Get > Class Template Reference

Proxy enables attribute interface of elements in a map. More...

#include <TextInterfaceEmbed.h>

Inheritance diagram for TextInterface::MapOfInterfaces< M, K, Get >:

Public Member Functions
	MapOfInterfaces (const std::string &pre, Get g)
	Construct from a pointer to parent class attribute interface.
	MapOfInterfaces (const MapOfInterfaces &copy)
	Copy constructor.
Attribute< M > *	clone () const
	Set the prefix to be added before attribute name.
std::string	get_name () const
	Get the name of the attribute.
std::string	get_description () const
	Get the description of the attribute.
std::string	get_value (const M *ptr) const
	Get the value of the attribute.
void	set_value (M *ptr, const std::string &value)
	Set the value of the attribute.
void	set_description (const std::string &)
	Set the description of the attribute.
void	set_detailed_description (const std::string &)
	Set the detailed description of the attribute.
bool	matches (const std::string &name) const
	Return true if the name argument matches.
Public Member Functions inherited from TextInterface::Attribute< M >
	Attribute ()
	Default constructor.
std::string	get_value () const
	Get the value of the attribute.
void	set_value (const std::string &value)
	Set the value of the attribute.
Public Member Functions inherited from TextInterface::Value
	Value ()
	Explicit default constructor required to delay definition of Reference::To<Parser>
	~Value ()
	Explicit destructor required to delay definition of Reference::To<Parser>
virtual std::string	get_detailed_description () const
	Get the detailed description of the value.
virtual void	set_modifiers (const std::string &) const =0
	Parse any modifiers that will alter the behaviour of the output stream.
virtual void	reset_modifiers () const =0
	Reset any output stream modifiers.
virtual void	set_parent (Parser *p)
Public Member Functions inherited from Reference::Able
	Able ()
	Default constructor.
	Able (const Able &)
	Copy constructor.
Able &	operator= (const Able &)
	Assignment operator.
virtual	~Able ()
	Destructor.
unsigned	get_reference_count () const
	Returns the number of references there are to this.
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked ()
	Default constructor.
	HeapTracked (const HeapTracked &)
	Copy constructor.
HeapTracked &	operator= (const HeapTracked &)
	Assignment operator.
virtual	~HeapTracked ()
	Destructor.
bool	__is_on_heap () const
	Return true if this instance is found in heap addresses.

Protected Member Functions
void	get_indeces (std::vector< K > &keys, const std::string &param) const
	Worker function parses keys for get_value and set_value.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
	Add the address of a reference to this object.
void	__dereference (bool auto_delete=true) const
	Remove the address of a reference to this object.

Protected Attributes
Get	get
	Method of M that returns element, given K.
std::string	prefix
	The name of the map instance.
std::string	range
	Range parsed from name during matches.
std::string	remainder
	Remainder parsed from name during matches.
Protected Attributes inherited from TextInterface::Value
Reference::To< Parser, false >	parent
	The Parser composite in which this Value component is integrated.

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
	Returns the current number instances in existence.
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
	Records the addresses of new instances allocated on the heap.
static void	operator delete (void *location, void *ptr)
	Placement delete overload to match the placement new overload.
static void	operator delete (void *location)
	Regular delete overload.
static size_t	get_heap_queue_size ()
	Return the number of heap addresses awaiting processing.
Public Attributes inherited from TextInterface::Attribute< M >
Reference::To< M, false >	instance
	Pointer to the instance from which attribute value will be obtained.

Detailed Description

template<class M, class K, class Get>
class TextInterface::MapOfInterfaces< M, K, Get >

Proxy enables attribute interface of elements in a map.

In this template: M is a map of key K to element E; Get is the method of V that returns E* given K

Member Function Documentation

clone()

template<class M, class K, class Get>

Attribute< M > * TextInterface::MapOfInterfaces< M, K, Get >::clone ( ) const

inlinevirtual

Set the prefix to be added before attribute name.

Retun a newly constructed copy

Implements TextInterface::Attribute< M >.

References TextInterface::Attribute< M >::Attribute(), and MapOfInterfaces().

get_description()

template<class M, class K, class Get>

std::string TextInterface::MapOfInterfaces< M, K, Get >::get_description ( ) const

inlinevirtual

Get the description of the attribute.

Implements TextInterface::Value.

References prefix.

get_name()

template<class M, class K, class Get>

std::string TextInterface::MapOfInterfaces< M, K, Get >::get_name ( ) const

inlinevirtual

Get the name of the attribute.

Implements TextInterface::Value.

References prefix.

matches()

template<class M, class K, class G>

bool TextInterface::MapOfInterfaces< M, K, G >::matches ( const std::string & name ) const

virtual

Return true if the name argument matches.

Reimplemented from TextInterface::Value.

References get, get_indeces(), TextInterface::Attribute< M >::instance, prefix, range, and remainder.

set_description()

template<class M, class K, class Get>

void TextInterface::MapOfInterfaces< M, K, Get >::set_description ( const std::string & )

inlinevirtual

Set the description of the attribute.

Implements TextInterface::Attribute< M >.

set_detailed_description()

template<class M, class K, class Get>

void TextInterface::MapOfInterfaces< M, K, Get >::set_detailed_description ( const std::string & )

inlinevirtual

Set the detailed description of the attribute.

Implements TextInterface::Attribute< M >.

---

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

• TextInterfaceEmbed.h