IpReferenced.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2006 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// $Id: IpReferenced.hpp 2182 2013-03-30 20:02:18Z stefan $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPREFERENCED_HPP__
#define __IPREFERENCED_HPP__

#include "IpTypes.hpp"
#include "IpDebug.hpp"

#include <list>

#if COIN_IPOPT_CHECKLEVEL > 3
  #define IP_DEBUG_REFERENCED
#endif

namespace Ipopt
{

  class Referencer
    {}
  ;

  class ReferencedObject
  {
  public:
    ReferencedObject()
        :
        reference_count_(0)
    {}

    virtual ~ReferencedObject()
    {
      DBG_ASSERT(reference_count_ == 0);
    }

    inline
    Index ReferenceCount() const;

    inline
    void AddRef(const Referencer* referencer) const;

    inline
    void ReleaseRef(const Referencer* referencer) const;

  private:
    mutable Index reference_count_;

#   ifdef IP_DEBUG_REFERENCED
    mutable std::list<const Referencer*> referencers_;
#   endif

  };

  /* inline methods */
  inline
  Index ReferencedObject::ReferenceCount() const
  {
    //    DBG_START_METH("ReferencedObject::ReferenceCount()", 0);
    //    DBG_PRINT((1,"Returning reference_count_ = %d\n", reference_count_));
    return reference_count_;
  }

  inline
  void ReferencedObject::AddRef(const Referencer* referencer) const
  {
    //    DBG_START_METH("ReferencedObject::AddRef(const Referencer* referencer)", 0);
    reference_count_++;
    //    DBG_PRINT((1, "New reference_count_ = %d\n", reference_count_));
#   ifdef IP_DEBUG_REFERENCED
    referencers_.push_back(referencer);
#   endif

  }

  inline
  void ReferencedObject::ReleaseRef(const Referencer* referencer) const
  {
    //    DBG_START_METH("ReferencedObject::ReleaseRef(const Referencer* referencer)",
    //                   0);
    reference_count_--;
    //    DBG_PRINT((1, "New reference_count_ = %d\n", reference_count_));

#   ifdef IP_DEBUG_REFERENCED

    bool found = false;
    std::list<const Referencer*>::iterator iter;
    for (iter = referencers_.begin(); iter != referencers_.end(); iter++) {
      if ((*iter) == referencer) {
        found = true;
        break;
      }
    }

    // cannot call release on a reference that was never added...
    DBG_ASSERT(found);

    if (found) {
      referencers_.erase(iter);
    }
#   endif

  }


} // namespace Ipopt

#endif