Ipopt Documentation  
IpTaggedObject.hpp
Go to the documentation of this file.
1 // Copyright (C) 2004, 2006 International Business Machines and others.
2 // All Rights Reserved.
3 // This code is published under the Eclipse Public License.
4 //
5 // $Id$
6 //
7 // Authors: Carl Laird, Andreas Waechter IBM 2004-08-13
8 
9 #ifndef __IPTAGGEDOBJECT_HPP__
10 #define __IPTAGGEDOBJECT_HPP__
11 
12 #include "IpUtils.hpp"
13 #include "IpDebug.hpp"
14 #include "IpReferenced.hpp"
15 #include "IpObserver.hpp"
16 
17 namespace Ipopt
18 {
19 
60 {
61 public:
63  typedef unsigned int Tag;
64 
67  :
68  Subject()
69  {
70  ObjectChanged();
71  }
72 
74  virtual ~TaggedObject()
75  {}
76 
81  Tag GetTag() const
82  {
83  return tag_;
84  }
85 
91  bool HasChanged(const Tag comparison_tag) const
92  {
93  return (comparison_tag == tag_) ? false : true;
94  }
95 protected:
101 private:
110 
112  void operator=(const TaggedObject&);
114 
121 
128 };
129 } // namespace Ipopt
130 #endif
Storing the reference count of all the smart pointers that currently reference it.
Slight Variation of the Observer Design Pattern (Subject part).
Definition: IpObserver.hpp:150
TaggedObject class.
Tag GetTag() const
Users of TaggedObjects call this to update their own internal tags every time they perform the expens...
TaggedObject(const TaggedObject &)
Copy Constructor.
void ObjectChanged()
Objects derived from TaggedObject MUST call this method every time their internal state changes to up...
bool HasChanged(const Tag comparison_tag) const
Users of TaggedObjects call this to check if the object HasChanged since they last updated their own ...
unsigned int Tag
Type for the Tag values.
Tag tag_
The tag indicating the current state of the object.
TaggedObject()
Constructor.
void operator=(const TaggedObject &)
Default Assignment Operator.
Index cache_priority_
The index indicating the cache priority for this TaggedObject.
virtual ~TaggedObject()
Destructor.
#define IPOPTLIB_EXPORT
This file contains a base class for all exceptions and a set of macros to help with exceptions.
int Index
Type of all indices of vectors, matrices etc.
Definition: IpTypes.hpp:17