Archive::Interface Class Reference

Provides a text interface to get and set Archive attributes. More...

#include <ArchiveInterface.h>

Inheritance diagram for Archive::Interface:

Public Member Functions
	Interface (Archive *=0)
	Default constructor that takes an optional instance.
	~Interface ()
	Desctructor.
void	set_instance (Archive *)
	Set the instance to which this interface interfaces.
TextInterface::Parser *	clone ()
	clone this text interface
std::string	get_interface_name () const
	Get the interface name.
Public Member Functions inherited from TextInterface::To< Archive >
virtual void	set_instance (C *c)
void	setup (const Value *value)
void i< parent->	size ()
const Attribute< C > *	get (unsigned i) const
Public Member Functions inherited from TextInterface::Parser
std::string	get_value (const std::string &name) const
std::string	get_name_value (std::string &name) const
void	set_value (const std::string &name, const std::string &value)
Value *	find (const std::string &name, bool throw_exception=true) const
bool	found (const std::string &name) const
bool	found (const std::string &prefix, const std::string &name) const
unsigned	get_nvalue () const
std::string	get_name (unsigned) const
std::string	get_value (unsigned) const
std::string	get_description (unsigned) const
virtual std::string	process (const std::string &command)
virtual std::string	process (const std::vector< std::string > &commands)
virtual std::string	help (bool show_default_values=false, bool show_header=false, const char *indent=0)
virtual std::string	get_interface_description () const
void	set_indentation (const std::string &indent)
void	set_delimiter (const std::string &)
void	set_prefix_name (bool flag)
void	set_aliases (const Alias *alias)
void	insert (Parser *)
void	insert (const std::string &prefix, Parser *)
void	clean ()
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Static Public Member Functions
static unsigned	get_instance_count ()
	Get the number of Archive::Interface instances.
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
static void	operator delete (void *location, void *ptr)
static void	operator delete (void *location)
static size_t	get_heap_queue_size ()

Additional Inherited Members
Protected Member Functions inherited from TextInterface::To< Archive >
void	add (T(P::*get)() const, const char *name, const char *description=0)
Protected Member Functions inherited from TextInterface::Parser
void	add_value (Value *value)
void	remove (const std::string &name)
void	clean_invalid ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const
Protected Attributes inherited from TextInterface::To< Archive >
Reference::To< C, false >	instance
Protected Attributes inherited from TextInterface::Parser
std::string	indentation
std::string	delimiter
bool	alphabetical
bool	import_filter
bool	prefix_name
Reference::To< const Alias >	aliases
std::vector< Reference::To< Value > >	values
std::vector< Reference::To< Parser > >	inserted

Detailed Description

Provides a text interface to get and set Archive attributes.

Member Function Documentation

get_interface_name()

std::string Pulsar::Archive::Interface::get_interface_name ( ) const

inlinevirtual

Get the interface name.

Reimplemented from TextInterface::Parser.

set_instance()

void Pulsar::Archive::Interface::set_instance

(

Pulsar::Archive *

c

)

Set the instance to which this interface interfaces.

Set the instance.

---

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

• ArchiveInterface.h
• ArchiveInterface.C