UtlIntPtr.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2011 SIPez LLC.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _UtlIntPtr_h_
#define _UtlIntPtr_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlDefs.h"
#include "utl/UtlCopyableContainable.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class UtlIntPtr : public UtlCopyableContainable
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    static const UtlContainableType TYPE ;    
/* ============================ CREATORS ================================== */

    UtlIntPtr(intptr_t initialValue = 0) ;
    UtlIntPtr(const UtlIntPtr& rhs) ;
      
    virtual ~UtlIntPtr();

    UtlCopyableContainable* clone() const;

/* ============================ OPERATORS ============================== */

    // Declare prefix and postfix increment operators.
    UtlIntPtr& operator++();       // Prefix increment operator
    UtlIntPtr operator++(int);     // Postfix increment operator

    // Declare prefix and postfix decrement operators.
    UtlIntPtr& operator--();       // Prefix decrement operator
    UtlIntPtr operator--(int);     // Postfix decrement operator

    UtlIntPtr& operator=(const UtlIntPtr& rhs); // assigment operator

    // Conversion to int
    operator intptr_t() { return mValue; }

/* ============================ MANIPULATORS ============================== */

    intptr_t setValue(intptr_t iValue) ;

/* ============================ ACCESSORS ================================= */

    intptr_t getValue() const ;    

    virtual unsigned hash() const ;

    virtual UtlContainableType getContainableType() const;
         
/* ============================ INQUIRY =================================== */

    virtual int compareTo(UtlContainable const *) const ;    

    virtual UtlBoolean isEqual(UtlContainable const *) const ; 

    virtual UtlBoolean isInstanceOf(const UtlContainableType type) const;

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    intptr_t mValue ;    

} ;

/* ============================ INLINE METHODS ============================ */

#endif    // _UtlIntPtr_h_