TextInterface::GetSetFunction< C, Get, Set > Class Template Reference

Interface to a class attribute with an accessor and modifier methods. More...

#include <TextInterfaceFunction.h>

Inheritance diagram for TextInterface::GetSetFunction< C, Get, Set >:
TextInterface::GetFunction< C, Get > TextInterface::Attribute< C > TextInterface::Value Reference::Able Reference::HeapTracked

Public Member Functions

 GetSetFunction (const std::string &_name, Get _get, Set _set)
 Constructor.
 
Attribute< C > * clone () const
 Return a clone.
 
void set_value (C *ptr, const std::string &value)
 Set the value of the attribute.
 
- Public Member Functions inherited from TextInterface::GetFunction< C, Get >
 GetFunction (const std::string &_name, Get _get)
 Constructor.
 
 GetFunction (const GetFunction &copy)
 Copy constructor.
 
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_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 bool matches (const std::string &name) const
 Return true if the name argument matches the value name.
 
virtual void set_parent (Parser *p)
 
- Public Member Functions inherited from Reference::Able
 Able ()
 Default constructor.
 
 Able (const Able &)
 Copy constructor.
 
Ableoperator= (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.
 
HeapTrackedoperator= (const HeapTracked &)
 Assignment operator.
 
virtual ~HeapTracked ()
 Destructor.
 
bool __is_on_heap () const
 Return true if this instance is found in heap addresses.
 

Protected Attributes

Set set
 The set method.
 
- Protected Attributes inherited from TextInterface::GetFunction< C, Get >
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 function object (functor)
 
- 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. More...
 
void __dereference (bool auto_delete=true) const
 Remove the address of a reference to this object. More...
 

Detailed Description

template<class C, class Get, class Set>
class TextInterface::GetSetFunction< C, Get, Set >

Interface to a class attribute with an accessor and modifier methods.


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

Generated using doxygen 1.8.17