sipxportlib  Version 3.3
Public Member Functions | Static Public Attributes | List of all members
UtlBool Class Reference

#include <UtlBool.h>

Inheritance diagram for UtlBool:
Inheritance graph
[legend]
Collaboration diagram for UtlBool:
Collaboration graph
[legend]

Public Member Functions

 UtlBool (bool bValue)
 
virtual ~UtlBool ()
 
virtual UtlCopyableContainableclone () const
 Make a copy of this. More...
 
void setValue (bool bValue)
 
bool getValue () const
 
virtual unsigned hash () const
 
virtual UtlContainableType getContainableType () const
 
virtual int compareTo (UtlContainable const *) const
 
virtual UtlBoolean isInstanceOf (const UtlContainableType type) const
 Determine if this object is a derivative of the specified UtlContainableType. More...
 
- Public Member Functions inherited from UtlCopyableContainable
 UtlCopyableContainable ()
 
virtual ~UtlCopyableContainable ()
 
- 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...
 

Static Public Attributes

static const UtlContainableType TYPE = "UtlBool"
 
- Static Public Attributes inherited from UtlCopyableContainable
static const UtlContainableType TYPE = "UtlCopyableContainable"
 
- 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

UtlBool is a UtlContainable wrapper for a bool.

Constructor & Destructor Documentation

UtlBool ( bool  bValue)

< Class type used for runtime checking Constructor

~UtlBool ( )
virtual

Destructor

Member Function Documentation

UtlCopyableContainable * clone ( ) const
virtual

Make a copy of this.

Implements UtlCopyableContainable.

void setValue ( bool  bValue)

Set a new bool value for this object.

bool getValue ( ) const

Get the bool 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.

Reimplemented from UtlCopyableContainable.

int compareTo ( UtlContainable const *  inVal) const
virtual

Compare the this object to another like-objects. Results for designating a non-like object are undefined.

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

Implements UtlContainable.

UtlBoolean isInstanceOf ( const UtlContainableType  type) const
virtual

Determine if this object is a derivative of the specified UtlContainableType.

Determine if this object is an instance of the designated runtime class identifer or one of its derivatives. For example:

if (pMyObject->isInstanceOf(UtlInt::TYPE))
{
    ...
}

If you want to determine if this object is exactly the same type as the given type (i.e. not a deriviative) use the following:

if(myObject->getContainableType() == UtlInt::TYPE)
{
    ...
}
Returns
TRUE/FALSE if this object is of the given type or a derivative of the given type.

Reimplemented from UtlCopyableContainable.

Member Data Documentation

UtlContainableType TYPE = "UtlBool"
static