OidxRange Class Reference

The OidxRange class provides functionality to define and compare OID ranges. More...

#include <snmp_pp_ext.h>

List of all members.

Public Member Functions

 OidxRange ()
 Default constructor.
 OidxRange (const Oidx &, const Oidx &)
 Create an OID range with lower and upper bound.
 OidxRange (const OidxRange &)
 Copy constructor.
virtual ~OidxRange ()
 Destructor.
virtual OidxRangeclone () const
 Clone.
virtual int operator== (const OidxRange &) const
 Compare the receiver with another OID range for equality.
virtual int operator< (const OidxRange &) const
 Compare the receiver with another OID range.
virtual int operator> (const OidxRange &) const
 Compare the receiver with another OID range.
virtual int includes (const Oidx &) const
 Check whether an OID is within the receiver's range.
virtual int includes_excl (const Oidx &) const
 Check whether an OID is within the receiver's range.
virtual boolean covers (const OidxRange &) const
 Check whether a range is covered by the receiver's range.
virtual boolean overlaps (const OidxRange &) const
 Check whether a range overlaps the receiver's range.
virtual Oidx get_lower () const
 Get lower bound.
virtual Oidx get_upper () const
 Get upper bound.

Public Attributes

Oidx lower
Oidx upper


Detailed Description

The OidxRange class provides functionality to define and compare OID ranges.

Version:
3.03
Author:
Frank Fock

Constructor & Destructor Documentation

OidxRange::OidxRange (  ) 

Default constructor.

OidxRange::OidxRange ( const Oidx ,
const Oidx  
)

Create an OID range with lower and upper bound.

Parameters:
lower the lower bound of the oid range (must be lexicographically less than upper)
upper the upper bound of the oid range

OidxRange::OidxRange ( const OidxRange  ) 

Copy constructor.

virtual OidxRange::~OidxRange (  )  [virtual]

Destructor.


Member Function Documentation

virtual OidxRange* OidxRange::clone (  )  const [virtual]

Clone.

Returns:
a pointer to a clone of the receiver.

virtual int OidxRange::operator== ( const OidxRange  )  const [virtual]

Compare the receiver with another OID range for equality.

Parameters:
other another OidxRange instance
Returns:
TRUE if lower and upper bounds of both OID ranges are equal

virtual int OidxRange::operator< ( const OidxRange  )  const [virtual]

Compare the receiver with another OID range.

Parameters:
other another OidxRange instance
Returns:
TRUE if the upper bound of the receiver is less or equal to the lower bound of other

virtual int OidxRange::operator> ( const OidxRange  )  const [virtual]

Compare the receiver with another OID range.

Parameters:
other another OidxRange instance
Returns:
TRUE if the lower bound of the receiver is greater or equal to the upper bound of other

virtual int OidxRange::includes ( const Oidx  )  const [virtual]

Check whether an OID is within the receiver's range.

Parameters:
oid an object identifier
Returns:
TRUE if oid is greater or equal to the receiver's lower bound and less or equal to its upper bound.

virtual int OidxRange::includes_excl ( const Oidx  )  const [virtual]

Check whether an OID is within the receiver's range.

Parameters:
oid an object identifier
Returns:
TRUE if oid is greater or equal the receiver's lower bound and less than its upper bound.

virtual boolean OidxRange::covers ( const OidxRange  )  const [virtual]

Check whether a range is covered by the receiver's range.

Parameters:
range a OidxRange instance
Returns:
TRUE if the lower bound of range is greater or equal the receiver's lower bound and if the upper bound of range is less or equal the upper bound of the receiver, FALSE otherwise

virtual boolean OidxRange::overlaps ( const OidxRange  )  const [virtual]

Check whether a range overlaps the receiver's range.

Parameters:
range a OidxRange instance
Returns:
TRUE if at least one oid is part of both ranges, FALSE otherwise

virtual Oidx OidxRange::get_lower (  )  const [virtual]

Get lower bound.

Returns:
the lower bound object identifier

virtual Oidx OidxRange::get_upper (  )  const [virtual]

Get upper bound.

Returns:
the upper bound object identifier


Member Data Documentation


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

Generated on Fri May 29 22:36:55 2009 for AGENT++ by  doxygen 1.5.6