TextInterface::Attribute< C > Class Template Reference

Text interface to a class attribute. More...

#include <TextInterfaceAttribute.h>

Inheritance diagram for TextInterface::Attribute< C >:

Public Member Functions
	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.
virtual Attribute *	clone () const =0
	Retun a newly constructed copy.
virtual std::string	get_value (const C *) const =0
	Get the value of the attribute.
virtual void	set_value (C *, const std::string &value)=0
	Set the value of the attribute.
virtual void	set_description (const std::string &)=0
	Set the description of the value.
virtual void	set_detailed_description (const std::string &)=0
	Set the detailed description of the value.
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_name () const =0
	Get the name of the value.
virtual std::string	get_description () const =0
	Get the description of the value.
virtual std::string	get_detailed_description () const
	Get the detailed description of the value.
virtual bool	matches (const std::string &name) const
	Return true if the name argument matches the value name.
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.

Public Attributes
Reference::To< C, false >	instance
	Pointer to the instance from which attribute value will be obtained.

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.
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 inherited from TextInterface::Value
Reference::To< Parser, false >	parent
	The Parser composite in which this Value component is integrated.

Detailed Description

template<class C>
class TextInterface::Attribute< C >

Text interface to a class attribute.

Member Function Documentation

clone()

template<class C>

virtual Attribute * TextInterface::Attribute< C >::clone ( ) const

pure virtual

Retun a newly constructed copy.

Implemented in TextInterface::AttributeGet< C, Get >, TextInterface::AttributeGetSet< C, Type, Get, Set >, TextInterface::AttributeXformGet< C, Get, X >, TextInterface::ElementGet< C, Get, Size >, TextInterface::ElementGetSet< C, Type, Get, Set, Size >, TextInterface::GetFunction< C, Get >, TextInterface::GetSetFunction< C, Get, Set >, TextInterface::HasAProxy< C, M, Get >, TextInterface::IsAProxy< C, P >, TextInterface::MapOfInterfaces< M, K, Get >, TextInterface::MapOfProxy< M, K, E, Get >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, TextInterface::VectorOfInterfaces< V, Get, Size >, and TextInterface::VectorOfProxy< V, E, Get, Size >.

References Attribute().

Referenced by TextInterface::HasAProxy< C, M, Get >::HasAProxy(), TextInterface::IsAProxy< C, P >::IsAProxy(), TextInterface::MapOfProxy< M, K, E, Get >::MapOfProxy(), and TextInterface::VectorOfProxy< V, E, Get, Size >::VectorOfProxy().

get_value() [1/2]

template<class C>

std::string TextInterface::Attribute< C >::get_value ( ) const

inlinevirtual

Get the value of the attribute.

Implements TextInterface::Value.

References get_value(), and instance.

Referenced by get_value(), and TextInterface::OptionalInterface< C, Type, Get, Set >::get_value().

get_value() [2/2]

template<class C>

virtual std::string TextInterface::Attribute< C >::get_value ( const C * ) const

pure virtual

Get the value of the attribute.

Implemented in TextInterface::AttributeGet< C, Get >, TextInterface::AttributeXformGet< C, Get, X >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::HasAProxy< C, M, Get >, TextInterface::IsAProxy< C, P >, and TextInterface::OptionalInterface< C, Type, Get, Set >.

set_description()

template<class C>

virtual void TextInterface::Attribute< C >::set_description ( const std::string & )

pure virtual

Set the description of the value.

Implemented in TextInterface::AttributeAdapter< C, M >, TextInterface::AttributeAdapter< C, P >, TextInterface::AttributeAdapter< M, E >, TextInterface::AttributeAdapter< V, E >, TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::MapOfInterfaces< M, K, Get >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, and TextInterface::VectorOfInterfaces< V, Get, Size >.

Referenced by TextInterface::To< C >::add(), TextInterface::To< C >::add(), TextInterface::To< C >::add(), TextInterface::To< C >::add(), TextInterface::To< C >::add(), TextInterface::To< C >::add(), TextInterface::To< C >::add(), TextInterface::To< C >::add(), and TextInterface::To< C >::add().

set_detailed_description()

template<class C>

virtual void TextInterface::Attribute< C >::set_detailed_description ( const std::string & )

pure virtual

Set the detailed description of the value.

Implemented in TextInterface::AttributeAdapter< C, M >, TextInterface::AttributeAdapter< C, P >, TextInterface::AttributeAdapter< M, E >, TextInterface::AttributeAdapter< V, E >, TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::MapOfInterfaces< M, K, Get >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, and TextInterface::VectorOfInterfaces< V, Get, Size >.

set_value() [1/2]

template<class C>

virtual void TextInterface::Attribute< C >::set_value ( C * , const std::string & value )

pure virtual

Set the value of the attribute.

Implemented in TextInterface::AttributeGet< C, Get >, TextInterface::AttributeGetSet< C, Type, Get, Set >, TextInterface::ElementGet< C, Get, Size >, TextInterface::ElementGetSet< C, Type, Get, Set, Size >, TextInterface::GetFunction< C, Get >, TextInterface::GetSetFunction< C, Get, Set >, TextInterface::HasAProxy< C, M, Get >, TextInterface::IsAProxy< C, P >, and TextInterface::OptionalInterface< C, Type, Get, Set >.

set_value() [2/2]

template<class C>

void TextInterface::Attribute< C >::set_value ( const std::string & value )

inlinevirtual

Set the value of the attribute.

Implements TextInterface::Value.

References instance, and set_value().

Referenced by set_value().

---

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

• TextInterfaceAttribute.h