ircproxy  The Ultimate Cyborg

---

IdentityReference.h

Go to the documentation of this file.

// ircproxy -- An IRC bouncer.
//
//! @file IdentityReference.h
//! @brief This file contains the declaration of class IdentityReference.
//
// Copyright (C) 2006, 2007 by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.

#ifndef IDENTITYREFERENCE_H
#define IDENTITYREFERENCE_H

class Identity;

//! \brief Base class for classes that always are related to exactly one Identity.
class IdentityReference {
private:
  Identity* M_identity;         //!< Pointer to the identity that this session is related to.

protected:
  //! Default constructor.
  IdentityReference(void) : M_identity(NULL) { }
  //! Construct an IdentityReference instance for identity \a identity.
  IdentityReference(Identity* identity) : M_identity(identity) { }

  //! Initialize the underlying Identity pointer.
  void set_identity(Identity* identity) { ASSERT(!M_identity); M_identity = identity; }

public:
  //! Returns a const reference to the underlying identity.
  Identity const& identity(void) const { return *M_identity; }

  //! Returns a reference to the underlying identity.
  Identity& identity(void) { return *M_identity; }

  //! Returns true when this object is associated with an Identity.
  bool has_identity(void) const { return M_identity; }
};

#endif // IDENTITYREFERENCE_H

---