wns::ObserverInterface< NOTIFICATIONINTERFACE > Class Template Reference
[Misc]

An observer's Interface to a subject. More...

#include <ObserverInterface.hpp>

Inherits NOTIFICATIONINTERFACE.

Inherited by wns::Observer< NOTIFICATIONINTERFACE > [virtual].

Collaboration diagram for wns::ObserverInterface< NOTIFICATIONINTERFACE >:

[legend]

List of all members.

Public Types
typedef NOTIFICATIONINTERFACE	NotificationType
	The NotificationInterface used by ObserverInterface and SubjectInterface.
typedef SubjectInterface < ObserverInterface >	SubjectType
	The SubjectInterface corresponding to this ObserverInterface.
Public Member Functions
virtual	~ObserverInterface ()
Private Member Functions
virtual void	addSubject (SubjectType *subject)=0
	Add a subject we are attached to.
virtual void	removeSubject (SubjectType *subject)=0
	Remove a subject we were attached to.
Friends
class	Subject< NOTIFICATIONINTERFACE >
	Only Subject should use this class.

---

Detailed Description

template<class NOTIFICATIONINTERFACE>
class wns::ObserverInterface< NOTIFICATIONINTERFACE >

Author:

Marc Schinnenburg <marc@schinnenburg.com>

Swen Kuehnlein

For internal use only.

Parameters:

NOTIFICATIONINTERFACE

The interface that contains the notification function. ObserverInterface will derive from that.

Note:

You should not need to instantiate this template yourself, as you can refer to the corresponding instantiation via Subject<NOTIFICATIONINTERFACE>::ObserverInterface and Observer<NOTIFICATIONINTERFACE>::ObserverInterface.

Remarks:

To resolve the mutual dependency of ObserverInterface and SubjectInterface, ObserverInterface includes SubjectInterface.hpp, whereas SubjectInterface gets the ObserverInterface as template parameter.

See also:

SubjectInterface, Observer, Subject.

Definition at line 66 of file ObserverInterface.hpp.

---

Member Typedef Documentation

template<class NOTIFICATIONINTERFACE>

typedef NOTIFICATIONINTERFACE wns::ObserverInterface< NOTIFICATIONINTERFACE >::NotificationType

This provides the NotificationInterface that is used by both this ObserverInterface and SubjectInterface.

Definition at line 82 of file ObserverInterface.hpp.

template<class NOTIFICATIONINTERFACE>

typedef SubjectInterface<ObserverInterface> wns::ObserverInterface< NOTIFICATIONINTERFACE >::SubjectType

This always refers to the SubjectInterface that uses the same NotificationInterface.

Reimplemented in wns::Observer< NOTIFICATIONINTERFACE >, wns::Observer< wns::service::phy::ofdma::CarrierSensing >, wns::Observer< wifimac::convergence::IChannelState >, wns::Observer< wifimac::convergence::INetworkAllocationVector >, wns::Observer< wns::service::phy::copper::Handler >, wns::Observer< wimemac::convergence::ITxStartEnd >, wns::Observer< wifimac::convergence::ITxStartEnd >, wns::Observer< wimemac::convergence::IChannelState >, wns::Observer< lte::controlplane::ResourceGrantNotificationInterface >, wns::Observer< wns::service::phy::copper::DataTransmissionFeedbackInterface >, wns::Observer< wns::events::scheduler::INotification >, wns::Observer< wimemac::convergence::IRxStartEnd >, wns::Observer< wifimac::convergence::IRxStartEnd >, wns::Observer< AssociationObserverInterface >, wns::Observer< wifimac::management::LinkNotificationInterface >, wns::Observer< wimac::service::ConnectionDeletedNotification >, wns::Observer< lte::timing::SuperFrameStartNotificationInterface >, wns::Observer< wns::service::phy::copper::CarrierSensing >, wns::Observer< wns::probe::bus::detail::IProbeBusNotification >, wns::Observer< ofdmaphy::RSSInterface >, and wns::Observer< wns::PositionObserver >.

Definition at line 89 of file ObserverInterface.hpp.

---

Constructor & Destructor Documentation

template<class NOTIFICATIONINTERFACE>

virtual wns::ObserverInterface< NOTIFICATIONINTERFACE >::~ObserverInterface

(

)

[inline, virtual]

Definition at line 92 of file ObserverInterface.hpp.

---

Member Function Documentation

template<class NOTIFICATIONINTERFACE>

virtual void wns::ObserverInterface< NOTIFICATIONINTERFACE >::addSubject

(

SubjectType *

subject

)

[private, pure virtual]

Parameters:

subject

A subject we are attached to.

Precondition:

The ObserverInterface instance must be attached to subject.

Postcondition:

The ObserverInterface instance will detach itself from subject on destruction.

Implemented in wns::Observer< NOTIFICATIONINTERFACE >, wns::Observer< wifimac::convergence::INetworkAllocationVector >, wns::Observer< wimemac::convergence::ITxStartEnd >, wns::Observer< wimemac::convergence::IRxStartEnd >, wns::Observer< wifimac::convergence::IRxStartEnd >, wns::Observer< wifimac::management::LinkNotificationInterface >, wns::Observer< lte::timing::SuperFrameStartNotificationInterface >, wns::Observer< wns::service::phy::copper::CarrierSensing >, wns::Observer< ofdmaphy::RSSInterface >, and wns::Observer< wns::PositionObserver >.

template<class NOTIFICATIONINTERFACE>

virtual void wns::ObserverInterface< NOTIFICATIONINTERFACE >::removeSubject

(

SubjectType *

subject

)

[private, pure virtual]

Parameters:

subject

The subject to remove.

Precondition:

subject must have been previously added with addSubject().

Postcondition:

The ObserverInterface install won't access subject in any way after the call is finished.

Implemented in wns::Observer< NOTIFICATIONINTERFACE >, wns::Observer< wifimac::convergence::INetworkAllocationVector >, wns::Observer< wimemac::convergence::ITxStartEnd >, wns::Observer< wimemac::convergence::IRxStartEnd >, wns::Observer< wifimac::convergence::IRxStartEnd >, wns::Observer< wifimac::management::LinkNotificationInterface >, wns::Observer< lte::timing::SuperFrameStartNotificationInterface >, wns::Observer< wns::service::phy::copper::CarrierSensing >, wns::Observer< ofdmaphy::RSSInterface >, and wns::Observer< wns::PositionObserver >.

---

Friends And Related Function Documentation

template<class NOTIFICATIONINTERFACE>

friend class Subject< NOTIFICATIONINTERFACE > [friend]

Subject is the only class with access to addSubject() and removeSubject().

Definition at line 74 of file ObserverInterface.hpp.

---

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

• framework/library/src/ObserverInterface.hpp