ClearSilver::ClearSilverNodeComparatorValue Class Reference

Comparator for ConstHDF dataset nodes based on the value.. More...

#include <ClearSilverNodeComparatorValue.h>

Inheritance diagram for ClearSilver::ClearSilverNodeComparatorValue:

ClearSilver::ClearSilverNodeComparator List of all members.

Public Types

typedef boost::shared_ptr<
ClearSilverNodeComparator
Ptr
 Pointer type.

Public Member Functions

 ClearSilverNodeComparatorValue ()
 Default constructor.
 ClearSilverNodeComparatorValue (const char *)
 Construct from a path to a child node.
 ClearSilverNodeComparatorValue (const std::string &)
 Construct from a path to a child node.
 ClearSilverNodeComparatorValue (const ClearSilverNodeComparatorValue &)
 Copy constructor.
virtual ~ClearSilverNodeComparatorValue () throw ()
 Destructor.
ClearSilverNodeComparatorValueoperator= (const ClearSilverNodeComparatorValue &)
 Assignment operator.
void swap (ClearSilverNodeComparatorValue &) throw ()
 Swap contents with another object.
virtual int operator() (const ConstHDF &, const ConstHDF &) const
 Compare two ConstHDF objects by the value of a child.
Constructors and assignment operators
void swap (ClearSilverNodeComparator &) throw ()
 Swap contents with another object.
Constructors and assignment operators
void swap (ClearSilverNodeComparator &) throw ()
 Swap contents with another object.

Detailed Description

Comparator for ConstHDF dataset nodes based on the value..

This class encapsulates the interface for comparison of two nodes in an HDF dataset based on the value of a specific descendent node. The path from each node to the compared child node is specified as a constructor argument and must be a valid path for each of the two nodes being compared.

Definition at line 60 of file ClearSilverNodeComparatorValue.h.


Member Function Documentation

int ClearSilver::ClearSilverNodeComparatorValue::operator() const ConstHDF ,
const ConstHDF
const [virtual]
 

Compare two ConstHDF objects by the value of a child.

This method is analogous to the sort function required by qsort(3). It returns -1, 0, or +1 depending on whether the value of the first child object is less than (<), equal (=), or greater than (>) the value of the second.

Implements ClearSilver::ClearSilverNodeComparator.

Definition at line 83 of file ClearSilverNodeComparatorValue.cc.


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  doxygen 1.4.5