MAKLogger::DtObserveEvent< SubjectType > Class Template Reference

DtObserveEvent represents an event which observers can be connected to and when the event is fired using the observeSubject call each observer has it's own function called. More...

Inheritance diagram for MAKLogger::DtObserveEvent< SubjectType >:

Collaboration diagram for MAKLogger::DtObserveEvent< SubjectType >:

Public Types
typedef DtObserver< SubjectType >	SubjectObserver
	Type definition for list of Observers.
typedef std::list< DtObserver < SubjectType > * >	ObserverList
Public Types inherited from MAKLogger::DtObserveConnectionComponent
typedef std::list < DtObserveConnectionSP >	ConnectionList

Public Member Functions
	DtObserveEvent ()
	CTOR for the object. No parameters are used.
virtual	~DtObserveEvent ()
	DTOR for the class.
virtual void	connect (DtObserveConnectionSP con)
	Connects an event to an existing shared connection.
virtual void	disconnect (DtObserveConnectionSP con)
	Disconnects an event from a shared connection.
virtual void	disconnect (SubjectObserver *observer)
	Disconnects the event from a specific observer.
void	observeSubject (const SubjectType &value)
	The event call which will cause all observers to observe the provided subject object.
Public Member Functions inherited from MAKLogger::DtObserveConnectionComponent
virtual	~DtObserveConnectionComponent ()
virtual void	disconnect (DtObserveConnectionComponent *component)
virtual bool	isConnected (DtObserveConnectionComponent *component)
void	disconnectAll ()
	Must be non virtual since called by destructor.

Protected Attributes
ObserverList	myObservers
	A list of observers to call when inspecting.
Protected Attributes inherited from MAKLogger::DtObserveConnectionComponent
ConnectionList	myConnections

Additional Inherited Members
Protected Member Functions inherited from MAKLogger::DtObserveConnectionComponent
	DtObserveConnectionComponent ()
	DtObserveConnection C.
	DtObserveConnectionComponent (const DtObserveConnectionComponent &)
	CopyCTOR not implemented.
DtObserveConnectionComponent &	operator= (const DtObserveConnectionComponent &)
	Assignment operator not implemented.
DtObserveConnectionSP	findEventObserverConnection (DtObserveConnectionComponent *event, DtObserveConnectionComponent *observer)

Detailed Description

template<typename SubjectType>
class MAKLogger::DtObserveEvent< SubjectType >

DtObserveEvent represents an event which observers can be connected to and when the event is fired using the observeSubject call each observer has it's own function called.

Member Typedef Documentation

template<typename SubjectType>

typedef std::list<DtObserver<SubjectType>*> MAKLogger::DtObserveEvent< SubjectType >::ObserverList

template<typename SubjectType>

typedef DtObserver<SubjectType> MAKLogger::DtObserveEvent< SubjectType >::SubjectObserver

Type definition for list of Observers.

Constructor & Destructor Documentation

template<typename SubjectType>

MAKLogger::DtObserveEvent< SubjectType >::DtObserveEvent ( )

inline

CTOR for the object. No parameters are used.

template<typename SubjectType>

virtual MAKLogger::DtObserveEvent< SubjectType >::~DtObserveEvent ( )

inlinevirtual

DTOR for the class.

Member Function Documentation

template<typename SubjectType>

virtual void MAKLogger::DtObserveEvent< SubjectType >::connect ( DtObserveConnectionSP  con )

inlinevirtual

Connects an event to an existing shared connection.

This function is used by the Connection object to connect Events to Observers.

Exceptions

DtInvalidInput

Thrown if the ConnectionSP is null.

Postcondition

Calls to inspect will call the observer in the input connection.

Warning

This function is public but is not callable by user code.

Reimplemented from MAKLogger::DtObserveConnectionComponent.

Referenced by MAKLogger::DtObserveEvent< DtMessageState >::connect().

template<typename SubjectType>

virtual void MAKLogger::DtObserveEvent< SubjectType >::disconnect ( DtObserveConnectionSP  con )

inlinevirtual

Disconnects an event from a shared connection.

This function is only called by the Connection object to disconnect Events and Observers

Returns

Return values

<value>	<interpretations of="" value>="">
<value>	<interpretations of="" value>="">

Exceptions

DtInvalidInput

Thrown if the ConnectionSP is null.

Precondition

<what must="" be="" true="" before="" this="" function="" is="" called>="">

Postcondition

<what will="" be="" true="" as="" a="" result="" of="" this="" function>="">

Warning

Reimplemented from MAKLogger::DtObserveConnectionComponent.

Referenced by MAKLogger::DtObserveEvent< DtMessageState >::disconnect().

template<typename SubjectType>

virtual void MAKLogger::DtObserveEvent< SubjectType >::disconnect ( SubjectObserver *  observer )

inlinevirtual

Disconnects the event from a specific observer.

template<typename SubjectType>

void MAKLogger::DtObserveEvent< SubjectType >::observeSubject ( const SubjectType &  value )

inline

The event call which will cause all observers to observe the provided subject object.

Member Data Documentation

template<typename SubjectType>

ObserverList MAKLogger::DtObserveEvent< SubjectType >::myObservers

protected

A list of observers to call when inspecting.

Referenced by MAKLogger::DtObserveEvent< DtMessageState >::connect(), MAKLogger::DtObserveEvent< DtMessageState >::disconnect(), and MAKLogger::DtObserveEvent< DtMessageState >::observeSubject().

---

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

• observeEvent.h