IpTaggedObject.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 Common Public License.
//
// $Id: IpTaggedObject.hpp 759 2006-07-07 03:07:08Z andreasw $
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPTAGGEDOBJECT_HPP__
#define __IPTAGGEDOBJECT_HPP__

#include "IpUtils.hpp"
#include "IpDebug.hpp"
#include "IpReferenced.hpp"
#include "IpObserver.hpp"
#include <limits>

namespace Ipopt
{

  class TaggedObject : public ReferencedObject, public Subject
  {
  public:
    typedef unsigned int Tag;

    TaggedObject()
        :
        Subject()
    {
      ObjectChanged();
    }

    virtual ~TaggedObject()
    {}

    Tag GetTag() const
    {
      return tag_;
    }

    bool HasChanged(const Tag comparison_tag) const
    {
      return (comparison_tag == tag_) ? false : true;
    }
  protected:
    void ObjectChanged()
    {
      DBG_START_METH("TaggedObject::ObjectChanged()", 0);
      tag_ = unique_tag_;
      unique_tag_++;
      DBG_ASSERT(unique_tag_ < std::numeric_limits<Tag>::max());
      // The Notify method from the Subject base class notifies all
      // registed Observers that this subject has changed.
      Notify(Observer::NT_Changed);
    }
  private:
    TaggedObject(const TaggedObject&);

    void operator=(const TaggedObject&);

    static Tag unique_tag_;

    Tag tag_;

    Index cache_priority_;
  };
} // namespace Ipopt
#endif