Ipopt::Observer Class Reference

Slight Variation of the Observer Design Pattern. More...

#include <IpObserver.hpp>

Inheritance diagram for Ipopt::Observer:

[legend]

List of all members.

Public Types
enum	NotifyType { NT_All, NT_BeingDestroyed, NT_Changed }
	Enumeration specifying the type of notification. More...
Public Member Functions
Constructors/Destructors
	Observer ()
	Default Constructor.
virtual	~Observer ()
	Default destructor.
Protected Member Functions
void	RequestAttach (NotifyType notify_type, const Subject *subject)
	Derived classes should call this method to request an "Attach" to a Subject.
void	RequestDetach (NotifyType notify_type, const Subject *subject)
	Derived classes should call this method to request a "Detach" to a Subject.
virtual void	RecieveNotification (NotifyType notify_type, const Subject *subject)=0
	Derived classes should overload this method to recieve the requested notification from attached Subjects.
Private Member Functions
void	ProcessNotification (NotifyType notify_type, const Subject *subject)
	Private Method for Recieving Notification should only be called by the friend class Subject.
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	Observer (const Observer &)
	Copy Constructor.
void	operator= (const Observer &)
	Overloaded Equals Operator.
Private Attributes
std::vector< const Subject * >	subjects_
	A list of the subjects currently being observed.
Friends
class	Subject

---

Detailed Description

Slight Variation of the Observer Design Pattern.

This class implements the Observer class of the Observer Design Pattern. An Observer "Attach"es to a Subject, indicating that it would like to be notified of changes in the Subject. Any derived class wishing to recieve notifications from a Subject should inherit off of Observer and overload the protected method, RecieveNotification_(...).

Definition at line 39 of file IpObserver.hpp.

---

Member Enumeration Documentation

enum Ipopt::Observer::NotifyType

Enumeration specifying the type of notification.

Enumerator:

NT_All
NT_BeingDestroyed
NT_Changed

Definition at line 58 of file IpObserver.hpp.

---

Constructor & Destructor Documentation

Ipopt::Observer::Observer

(

)

[inline]

Default Constructor.

Definition at line 50 of file IpObserver.hpp.

Ipopt::Observer::~Observer

(

)

[inline, virtual]

Default destructor.

Definition at line 190 of file IpObserver.hpp.

Ipopt::Observer::Observer

(

const Observer &

)

[private]

Copy Constructor.

---

Member Function Documentation

void Ipopt::Observer::RequestAttach	(	NotifyType	notify_type,
		const Subject *	subject
	)			[inline, protected]

Derived classes should call this method to request an "Attach" to a Subject.

Do not call "Attach" explicitly on the Subject since further processing is done here

Definition at line 211 of file IpObserver.hpp.

void Ipopt::Observer::RequestDetach	(	NotifyType	notify_type,
		const Subject *	subject
	)			[inline, protected]

Derived classes should call this method to request a "Detach" to a Subject.

Do not call "Detach" explicitly on the Subject since further processing is done here

Definition at line 230 of file IpObserver.hpp.

virtual void Ipopt::Observer::RecieveNotification	(	NotifyType	notify_type,
		const Subject *	subject
	)			[protected, pure virtual]

Derived classes should overload this method to recieve the requested notification from attached Subjects.

Implemented in Ipopt::DependentResult< T >.

void Ipopt::Observer::operator=

(

const Observer &

)

[private]

Overloaded Equals Operator.

Reimplemented in Ipopt::DependentResult< T >.

void Ipopt::Observer::ProcessNotification	(	NotifyType	notify_type,
		const Subject *	subject
	)			[inline, private]

Private Method for Recieving Notification should only be called by the friend class Subject.

This method will, in turn, call the overloaded RecieveNotification method for the derived class to process.

Definition at line 260 of file IpObserver.hpp.

---

Friends And Related Function Documentation

friend class Subject [friend]

Definition at line 114 of file IpObserver.hpp.

---

Member Data Documentation

std::vector<const Subject*> Ipopt::Observer::subjects_ [private]

A list of the subjects currently being observed.

Definition at line 104 of file IpObserver.hpp.

---

The documentation for this class was generated from the following file:

• /home/coin/svn-release/OptimizationSuite-1.1.0/Ipopt/src/Common/IpObserver.hpp