ClearSilver::HDFNode Class Reference

ClearSilver HDF dataset node. More...

#include <HDFNode.h>

Inheritance diagram for ClearSilver::HDFNode:

List of all members.

Public Types
typedef std::string	Name
Public Member Functions
virtual ClearSilverNode	node () const =0
	Access to the current node.
void	sort (ClearSilverNodeComparator::Ptr)
	Sort the children of the current node.
Constructors and assignment operators
	HDFNode ()
	Default constructor.
	HDFNode (const HDFNode &)
	Copy constructor.
	~HDFNode () throw ()
	Destructor.
HDF dataset operations
Most of these functions directly encapsulate the corresponding functions from the ClearSilver C API. Note that the constants returned by ConstHDFNode::True() and ConstHDFNode::False() are used internally to represent the corresponding boolean values in the dataset.
void	set_value (const char *value)
void	set_value (const std::string &value)
void	set_value (int value)
void	set_value (bool value)
void	set_value (const char *key, const char *value)
void	set_value (const std::string &key, const std::string &value)
void	set_value (const char *key, int value)
void	set_value (const std::string &key, int value)
void	set_value (const char *key, unsigned int value)
void	set_value (const std::string &key, unsigned int value)
void	set_value (const char *key, bool value)
void	set_value (const std::string &key, bool value)
void	read_file (const char *filename)
void	read_file (const std::string &filename)
Delete subtree methods
Note that these methods invalidate any references and iterators referring to nodes within the deleted subtree.
void	remove_tree (const char *key)
	Remove the subtree rooted at path.
void	remove_tree (const std::string &key)
	Remove the subtree rooted at path.
void	remove_tree (HDF &)
	Remove the subtree referenced by the HDF object.
void	remove_cgi ()
	Delete the entire CGI environment from the HDF dataset.
Static Public Member Functions
static bool &	debug ()
	Access the debug flag.
Protected Member Functions
void	swap (HDFNode &) throw ()
	Swap contents with another object.
virtual void	push (const Name &, const ClearSilverNode &)=0
virtual void	pop ()=0
virtual ClearSilverNode	top () const =0

---

Detailed Description

ClearSilver HDF dataset node.

This class encapsulates the non-constant portion of the interface to a ClearSilver HDF dataset node.

Definition at line 61 of file HDFNode.h.

---

Member Function Documentation

bool & ClearSilver::HDFNode::debug (   )  [static]

Access the debug flag. If the debug flag is true, syslog(3) messages with priority LOG_DEBUG will be logged. Reimplemented in ClearSilver::HDF. Definition at line 187 of file HDFNode.cc.

void ClearSilver::HDFNode::remove_cgi (   )

Delete the entire CGI environment from the HDF dataset. The CGI environment that is deleted includes nodes rooted at the following paths: CGI, HTTP, Query, and Cookie. Note that this method invalidates any references and iterators referring to nodes within the deleted subtrees. Definition at line 173 of file HDFNode.cc. References remove_tree().

---

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

• HDFNode.h
• HDFNode.cc

---