TextInterface::ElementGet< C, Get, Size > Class Template Reference

Interface to an array of attributes. More...

#include <TextInterfaceElement.h>

Inheritance diagram for TextInterface::ElementGet< C, Get, Size >:

Public Member Functions
	ElementGet (const std::string &_name, Get _get, Size _size)
	Constructor.
Attribute< C > *	clone () const
	Return a clone.
std::string	get_name () const
	Get the name of the attribute.
std::string	get_description () const
	Get the description of the attribute.
void	set_description (const std::string &d)
	Get the description of the attribute.
std::string	get_detailed_description () const
	Get the detailed description of the attribute.
void	set_detailed_description (const std::string &d)
	Get the detailed description of the attribute.
std::string	get_value (const C *ptr) const
	Get the value of the attribute.
void	set_value (C *, const std::string &)
	Set the value of the attribute.
bool	matches (const std::string &name) const
	Return true if the name argument matches.
void	set_modifiers (const std::string &modifiers) const
	Parse any modifiers that will alter the behaviour of the output stream.
void	reset_modifiers () const
	Reset any output stream modifiers.
Public Member Functions inherited from TextInterface::Attribute< C >
	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 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 Attributes
std::string	name
	The name of the attribute.
std::string	description
	The description of the attribute.
std::string	detailed_description
	The detailed description of the attribute.
Get	get
	The get method.
Size	size
	The size method.
std::string	range
	Range 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< C >
Reference::To< C, false >	instance
	Pointer to the instance from which attribute value will be obtained.
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.

Detailed Description

template<class C, class Get, class Size>
class TextInterface::ElementGet< C, Get, Size >

Interface to an array of attributes.

In this template: C is a class that contains a vector of elements; Get is the accessor method of C that returns an element of the vector at a given index; and Size is the method of C that returns the number of elements in the vector.

Member Function Documentation

clone()

template<class C, class Get, class Size>

Attribute< C > * TextInterface::ElementGet< C, Get, Size >::clone ( ) const

inlinevirtual

Return a clone.

Implements TextInterface::Attribute< C >.

Reimplemented in TextInterface::ElementGetSet< C, Type, Get, Set, Size >.

References TextInterface::Attribute< C >::Attribute(), and ElementGet().

get_description()

template<class C, class Get, class Size>

std::string TextInterface::ElementGet< C, Get, Size >::get_description ( ) const

inlinevirtual

Get the description of the attribute.

Implements TextInterface::Value.

References description.

get_detailed_description()

template<class C, class Get, class Size>

std::string TextInterface::ElementGet< C, Get, Size >::get_detailed_description ( ) const

inlinevirtual

Get the detailed description of the attribute.

Reimplemented from TextInterface::Value.

References detailed_description.

get_name()

template<class C, class Get, class Size>

std::string TextInterface::ElementGet< C, Get, Size >::get_name ( ) const

inlinevirtual

Get the name of the attribute.

Implements TextInterface::Value.

References name.

get_value()

template<class C, class G, class S>

std::string TextInterface::ElementGet< C, G, S >::get_value ( const C * ptr ) const

virtual

Get the value of the attribute.

Implements TextInterface::Attribute< C >.

References get, name, TextInterface::Value::parent, range, and size.

matches()

template<class C, class Get, class Size>

bool TextInterface::ElementGet< C, Get, Size >::matches ( const std::string & name ) const

virtual

Return true if the name argument matches.

Reimplemented from TextInterface::Value.

References name, and range.

reset_modifiers()

template<class C, class Get, class Size>

void TextInterface::ElementGet< C, Get, Size >::reset_modifiers ( ) const

inlinevirtual

Reset any output stream modifiers.

Implements TextInterface::Value.

set_description()

template<class C, class Get, class Size>

void TextInterface::ElementGet< C, Get, Size >::set_description ( const std::string & d )

inlinevirtual

Get the description of the attribute.

Implements TextInterface::Attribute< C >.

References description.

Referenced by TextInterface::VAllocator< C, Type >::operator()(), and TextInterface::VAllocator< C, Type >::operator()().

set_detailed_description()

template<class C, class Get, class Size>

void TextInterface::ElementGet< C, Get, Size >::set_detailed_description ( const std::string & d )

inlinevirtual

Get the detailed description of the attribute.

Implements TextInterface::Attribute< C >.

References detailed_description.

set_modifiers()

template<class C, class Get, class Size>

void TextInterface::ElementGet< C, Get, Size >::set_modifiers ( const std::string & modifiers ) const

inlinevirtual

Parse any modifiers that will alter the behaviour of the output stream.

Implements TextInterface::Value.

set_value()

template<class C, class Get, class Size>

void TextInterface::ElementGet< C, Get, Size >::set_value ( C * , const std::string &  )

inlinevirtual

Set the value of the attribute.

Implements TextInterface::Attribute< C >.

Reimplemented in TextInterface::ElementGetSet< C, Type, Get, Set, Size >.

References name.

---

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

• TextInterfaceElement.h