TextInterface::Value Class Reference

Text interface to a value of undefined type. More...

#include <TextInterfaceValue.h>

Inheritance diagram for TextInterface::Value:

Public Member Functions
	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_value () const =0
	Get the value as text.
virtual void	set_value (const std::string &value)=0
	Set the value as text.
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.

Protected Attributes
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.
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

Text interface to a value of undefined type.

Member Function Documentation

get_description()

virtual std::string TextInterface::Value::get_description ( ) const

pure virtual

Get the description of the value.

Implemented in TextInterface::AdapterBase< Attribute< C >, Attribute< M > >, TextInterface::AdapterBase< Attribute< C >, Attribute< P > >, TextInterface::AdapterBase< Attribute< M >, Attribute< E > >, TextInterface::AdapterBase< Attribute< V >, Attribute< E > >, TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::Interpreter< I, Get, Set >, TextInterface::MapOfInterfaces< M, K, Get >, TextInterface::NestedValue, TextInterface::ValueGet< T >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, and TextInterface::VectorOfInterfaces< V, Get, Size >.

get_detailed_description()

virtual std::string TextInterface::Value::get_detailed_description ( ) const

inlinevirtual

Get the detailed description of the value.

Reimplemented in TextInterface::AdapterBase< Attribute< C >, Attribute< M > >, TextInterface::AdapterBase< Attribute< C >, Attribute< P > >, TextInterface::AdapterBase< Attribute< M >, Attribute< E > >, TextInterface::AdapterBase< Attribute< V >, Attribute< E > >, TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::Interpreter< I, Get, Set >, TextInterface::ValueGet< T >, and TextInterface::VectorOfEstimate< V, T, U, Get, Size >.

get_name()

virtual std::string TextInterface::Value::get_name ( ) const

pure virtual

Get the name of the value.

Implemented in TextInterface::AdapterBase< Attribute< C >, Attribute< M > >, TextInterface::AdapterBase< Attribute< C >, Attribute< P > >, TextInterface::AdapterBase< Attribute< M >, Attribute< E > >, TextInterface::AdapterBase< Attribute< V >, Attribute< E > >, TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::HasAProxy< C, M, Get >, TextInterface::Interpreter< I, Get, Set >, TextInterface::MapOfInterfaces< M, K, Get >, TextInterface::MapOfProxy< M, K, E, Get >, TextInterface::NestedValue, TextInterface::OptionalInterface< C, Type, Get, Set >, TextInterface::ValueGet< T >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, TextInterface::VectorOfInterfaces< V, Get, Size >, and TextInterface::VectorOfProxy< V, E, Get, Size >.

Referenced by TextInterface::Parser::add_value(), TextInterface::Parser::insert(), matches(), TextInterface::To< C >::setup(), and TextInterface::To< C >::size().

get_value()

virtual std::string TextInterface::Value::get_value ( ) const

pure virtual

Get the value as text.

Implemented in TextInterface::Attribute< C >, TextInterface::Attribute< M >, TextInterface::Attribute< V >, TextInterface::Interpreter< I, Get, Set >, TextInterface::NestedValue, and TextInterface::ValueGet< T >.

Referenced by TextInterface::Parser::get_name_value().

matches()

virtual bool TextInterface::Value::matches ( const std::string & name ) const

inlinevirtual

Return true if the name argument matches the value name.

Reimplemented in TextInterface::ElementGet< C, Get, Size >, TextInterface::HasAProxy< C, M, Get >, TextInterface::MapOfInterfaces< M, K, Get >, TextInterface::MapOfProxy< M, K, E, Get >, TextInterface::NestedValue, TextInterface::OptionalInterface< C, Type, Get, Set >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, TextInterface::VectorOfInterfaces< V, Get, Size >, and TextInterface::VectorOfProxy< V, E, Get, Size >.

References get_name().

reset_modifiers()

void TextInterface::Value::reset_modifiers ( ) const

pure virtual

Reset any output stream modifiers.

Implemented in TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::Interpreter< I, Get, Set >, TextInterface::NestedValue, TextInterface::OptionalInterface< C, Type, Get, Set >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, and TextInterface::VectorOfInterfaces< V, Get, Size >.

Referenced by TextInterface::Parser::get_name_value().

set_modifiers()

void TextInterface::Value::set_modifiers ( const std::string & modifiers ) const

pure virtual

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

Implemented in TextInterface::AttributeGet< C, Get >, TextInterface::ElementGet< C, Get, Size >, TextInterface::GetFunction< C, Get >, TextInterface::Interpreter< I, Get, Set >, TextInterface::NestedValue, TextInterface::OptionalInterface< C, Type, Get, Set >, TextInterface::VectorOfEstimate< V, T, U, Get, Size >, and TextInterface::VectorOfInterfaces< V, Get, Size >.

Referenced by TextInterface::Parser::get_name_value().

set_value()

virtual void TextInterface::Value::set_value ( const std::string & value )

pure virtual

Set the value as text.

Implemented in TextInterface::Attribute< C >, TextInterface::Attribute< M >, TextInterface::Attribute< V >, TextInterface::Interpreter< I, Get, Set >, TextInterface::NestedValue, TextInterface::ValueGet< T >, and TextInterface::ValueGetSet< T >.

---

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

• TextInterfaceValue.h
• TextInterfaceValue.C