UtlContainablePair.h

Go to the documentation of this file.

//
// Copyright (C) 2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2008 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// $$


#ifndef _UtlContainablePair_h_
#define _UtlContainablePair_h_

// SYSTEM INCLUDES
#include "os/OsDefs.h"

// APPLICATION INCLUDES
#include "utl/UtlDefs.h"
#include "utl/UtlContainable.h"

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

class UtlContainablePair : public UtlContainable
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    static const UtlContainableType TYPE; 

/* ============================ CREATORS ================================== */

    UtlContainablePair(UtlContainable *pFirst, UtlContainable *pSecond);
     
    virtual ~UtlContainablePair();

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

    UtlContainable* setFirst(UtlContainable *val);
    UtlContainable* setSecond(UtlContainable *val);
/* ============================ ACCESSORS ================================= */

    UtlContainable* getFirst() const;    

    UtlContainable* getSecond() const;    

    virtual unsigned hash() const;
    virtual UtlContainableType getContainableType() const;

/* ============================ INQUIRY =================================== */

    virtual int compareTo(UtlContainable const *) const;
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    UtlContainable *mpFirst;   
    UtlContainable *mpSecond;  
};

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

#endif  // _UtlContainablePair_h_