ClearSilver::ClearSilverNodeComparator Class Reference

Comparator for ConstHDF dataset nodes. More...

#include <ClearSilverNodeComparator.h>

Inheritance diagram for ClearSilver::ClearSilverNodeComparator:

List of all members.

Public Types
typedef boost::shared_ptr< ClearSilverNodeComparator >	Ptr
	Pointer type.
Public Member Functions
virtual int	operator() (const ConstHDF &, const ConstHDF &) const =0
	Compare two HDF dataset nodes.
Constructors and assignment operators
	ClearSilverNodeComparator ()
	Default constructor.
	ClearSilverNodeComparator (const ClearSilverNodeComparator &)
	Copy constructor.
virtual	~ClearSilverNodeComparator () throw ()
	Destructor.
ClearSilverNodeComparator &	operator= (const ClearSilverNodeComparator &)
	Assignment operator.
void	swap (ClearSilverNodeComparator &) throw ()
	Swap contents with another object.

---

Detailed Description

Comparator for ConstHDF dataset nodes.

This class encapsulates the interface for comparison of two nodes in an HDF dataset. It is intended as a base for derived classes that implement concrete comparison policies. Comparison is between two ConstHDF objects, as opposed to two ClearSilverNode objects, in order to allow comparison policies to be written based on the full ConstHDF interface. Consequently, if necessary nodes may be sorted based on the value of descendent nodes.

Definition at line 64 of file ClearSilverNodeComparator.h.

---

Member Function Documentation

virtual int ClearSilver::ClearSilverNodeComparator::operator() (  const ConstHDF &  , const ConstHDF &  )  const [pure virtual]

Compare two HDF dataset nodes. This method is analogous to the sort function required by qsort(3). It returns -1, 0, or +1 depending on whether the first object is less than (<), equal (=), or greater than (>) the second. Implemented in ClearSilver::ClearSilverNodeComparatorName, and ClearSilver::ClearSilverNodeComparatorValue.

---

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

• ClearSilverNodeComparator.h
• ClearSilverNodeComparator.cc

---