UtlContainablePair Class Reference

A UtlContainable wrapper for a pair of UtlContainable objects. More...

#include <UtlContainablePair.h>

Inheritance diagram for UtlContainablePair:

Collaboration diagram for UtlContainablePair:

Public Member Functions
	UtlContainablePair (UtlContainable *pFirst, UtlContainable *pSecond)
	Constructor accepting an optional default value. More...
virtual	~UtlContainablePair ()
	Destructor. More...
UtlContainable *	setFirst (UtlContainable *val)
	Set a new first value for this object. More...
UtlContainable *	setSecond (UtlContainable *val)
	Set a new second value for this object. More...
UtlContainable *	getFirst () const
	Get the first value wrapped by this object. More...
UtlContainable *	getSecond () const
	Get the second value wrapped by this object. More...
virtual unsigned	hash () const
	Calculate a unique hash code for this object. More...
virtual UtlContainableType	getContainableType () const
	Get the ContainableType for a UtlContainable derived class. More...
virtual int	compareTo (UtlContainable const *) const
	Compare the this object to another like-objects. More...
Public Member Functions inherited from UtlContainable
virtual	~UtlContainable ()
unsigned	directHash () const
	Provides a hash function that uses the object pointer as the hash value. More...
virtual UtlBoolean	isEqual (UtlContainable const *) const
	Test this object to another object for equality. More...
virtual UtlBoolean	isInstanceOf (const UtlContainableType type) const
	Determine if this object is a derivative of the specified UtlContainableType. More...

Static Public Attributes
static const UtlContainableType	TYPE = "UtlContainablePair"
	Class type used for runtime checking. More...
Static Public Attributes inherited from UtlContainable
static const UtlContainableType	TYPE = "UtlContainable"

Additional Inherited Members
Static Public Member Functions inherited from UtlContainable
static unsigned	stringHash (char const *value)
	Provides a hash function appropriate for null-terminated string values. More...
static UtlBoolean	areSameTypes (const UtlContainableType type1, const UtlContainableType type2)
	Are UtlContainable types the same. More...

Detailed Description

A UtlContainable wrapper for a pair of UtlContainable objects.

Constructor & Destructor Documentation

UtlContainablePair	(	UtlContainable *	pFirst,
		UtlContainable *	pSecond
	)

Constructor accepting an optional default value.

~UtlContainablePair ( )

virtual

Destructor.

Member Function Documentation

UtlContainable * setFirst

(

UtlContainable *

val

)

Set a new first value for this object.

Returns

The old first value.

UtlContainable * setSecond

(

UtlContainable *

val

)

Set a new second value for this object.

Returns

The old second value.

UtlContainable * getFirst

(

)

const

Get the first value wrapped by this object.

UtlContainable * getSecond

(

)

const

Get the second value wrapped by this object.

unsigned hash ( ) const

virtual

Calculate a unique hash code for this object.

If the equals operator returns true for another object, then both of those objects must return the same hashcode.

Implements UtlContainable.

UtlContainableType getContainableType ( ) const

virtual

Get the ContainableType for a UtlContainable derived class.

Implements UtlContainable.

int compareTo ( UtlContainable const *  inVal ) const

virtual

Compare the this object to another like-objects.

Compares mpFirst values, and return corresponding value if they're not equal. If mpFirst values are equal, return result of mpSecond values comparison.

Results for designating a non-like object are undefined.

Returns

0 if equal, < 0 if less then and >0 if greater.

Implements UtlContainable.

Member Data Documentation

const UtlContainableType TYPE = "UtlContainablePair"

static

Class type used for runtime checking.