ClearSilver::Nodes Class Reference

Path to current node. More...

#include <Nodes.h>

List of all members.

Public Types

typedef std::string Name

typedef NodeContainer::size_type size_type

Public Member Functions

bool empty () const

Is the node path empty?

size_type size () const

Size of the node path.

std::string path () const

String representation of the entire path.

size_type depth () const

Depth of the current node within the dataset.

void push (const Name &, const ClearSilverNode &)

Add a (Name, ClearSilverNode) pair to the end of the node path.

void pop ()

Remove the last (Name, ClearSilverNode) pair from the path.

ClearSilverNode top () const

Return the last ClearSilverNode (i.e., the current node) on the path.

void swap (Nodes &) throw ()

Swap contents with another object.

void print () const

Print the path.

Constructors and assignment operators

Nodes ()

Default constructor.

Nodes (const Nodes &n)

Copy constructor.

~Nodes ()

Destructor.

Nodes & operator= (const Nodes &n)

Assignment operator.

Static Public Member Functions

static bool & debug ()

Access the debug flag.

Friends

bool operator== (const Nodes &, const Nodes &)

Equality operator.

Detailed Description

Path to current node.

This class encapsulates the path to the current node. This is required because

The underlying C API provides no means of retrieving the path from an individual HDF dataset node, yet
The underlying C API requires a path to specify the node being operated on.

Definition at line 64 of file Nodes.h.

Member Function Documentation

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

Access the debug flag.
If the debug flag is true, syslog(3) messages with priority LOG_DEBUG will be logged.
Definition at line 161 of file Nodes.cc.

void ClearSilver::Nodes::print ( ) const

Print the path.
This method prints the path as a series of syslog(3) messages with priority LOG_DEBUG. This is primarily for debuging other parts of the library; although, it may have some general use.
Definition at line 169 of file Nodes.cc.
References std::list< _Tp, _Alloc >::begin(), std::list< _Tp, _Alloc >::end(), and hex().

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

Generated on Tue May 16 14:50:54 2006 for ClearSilver C++ Library by

1.4.5


Public Types
typedef std::string	Name
typedef NodeContainer::size_type	size_type
Public Member Functions
bool	empty () const
	Is the node path empty?
size_type	size () const
	Size of the node path.
std::string	path () const
	String representation of the entire path.
size_type	depth () const
	Depth of the current node within the dataset.
void	push (const Name &, const ClearSilverNode &)
	Add a (Name, ClearSilverNode) pair to the end of the node path.
void	pop ()
	Remove the last (Name, ClearSilverNode) pair from the path.
ClearSilverNode	top () const
	Return the last ClearSilverNode (i.e., the current node) on the path.
void	swap (Nodes &) throw ()
	Swap contents with another object.
void	print () const
	Print the path.
Constructors and assignment operators
	Nodes ()
	Default constructor.
	Nodes (const Nodes &n)
	Copy constructor.
	~Nodes ()
	Destructor.
Nodes &	operator= (const Nodes &n)
	Assignment operator.
Static Public Member Functions
static bool &	debug ()
	Access the debug flag.
Friends
bool	operator== (const Nodes &, const Nodes &)
	Equality operator.