VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes
makVrv::DtSubjectAnnouncer< T > Class Template Reference

A DtSubjectAnnouncer tells DtSubjectObservers that the subject T is activated or deactivated. More...

Inheritance diagram for makVrv::DtSubjectAnnouncer< T >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::list< T * > ActivatedList

Public Member Functions

virtual ~DtSubjectAnnouncer ()
virtual void activate (T *subject) const
 Causes the activate signal to be emitted.
virtual void deactivate (T *subject) const
 Causes the deactivate signal to be emitted.
virtual std::list< T * > & activatedList ()
 Return the list of activated subjects.

Static Public Member Functions

static DtSubjectAnnouncerfindInstance (DtDe &de)
 Get the instance of this object. This object is 'lazily created'.

Public Attributes

boost::signal< void(T *)> signal_activate
 Signal with a T argument and a void return value.
boost::signal< void(T *)> signal_deactivate
 Signal with a DtIgDisplayUserInterface argument and a void return value.

Protected Member Functions

 DtSubjectAnnouncer (DtDe &de)
 The constructor for this class is protected. Use create().
virtual void slot_onActivate (T *subject)
 Connected to its own signal_activate which adds subjects to the activated list.
virtual void slot_onDeactivate (T *subject)
 Connected to its own signal_deactivate which removes subjects from the activated list.

Static Protected Member Functions

static DtSubjectAnnouncercreate (DtDe &de)
 Static creator function.

Protected Attributes

ActivatedList myActivatedList
 List of activated subjects.

Detailed Description

template<class T>
class makVrv::DtSubjectAnnouncer< T >

A DtSubjectAnnouncer tells DtSubjectObservers that the subject T is activated or deactivated.


Member Typedef Documentation

template<class T>
typedef std::list<T*> makVrv::DtSubjectAnnouncer< T >::ActivatedList

Constructor & Destructor Documentation

template<class T >
makVrv::DtSubjectAnnouncer< T >::~DtSubjectAnnouncer ( ) [virtual]
template<class T >
makVrv::DtSubjectAnnouncer< T >::DtSubjectAnnouncer ( DtDe de) [protected]

The constructor for this class is protected. Use create().


Member Function Documentation

template<class T >
DtSubjectAnnouncer< T > * makVrv::DtSubjectAnnouncer< T >::findInstance ( DtDe de) [static]

Get the instance of this object. This object is 'lazily created'.

References makVrv::DtDe::findInstance(), and makVrv::DtDe::registerInstance().

Referenced by makVrv::DtSubjectObserver< T >::connect().

template<class T >
void makVrv::DtSubjectAnnouncer< T >::activate ( T *  subject) const [virtual]

Causes the activate signal to be emitted.

template<class T >
void makVrv::DtSubjectAnnouncer< T >::deactivate ( T *  subject) const [virtual]

Causes the deactivate signal to be emitted.

template<class T >
std::list< T * > & makVrv::DtSubjectAnnouncer< T >::activatedList ( ) [virtual]

Return the list of activated subjects.

Referenced by makVrv::DtSubjectObserver< T >::connect().

template<class T >
DtSubjectAnnouncer< T > * makVrv::DtSubjectAnnouncer< T >::create ( DtDe de) [static, protected]

Static creator function.

This class is 'lazily created' when needed. Creation happens during the first call to findInstance().

template<class T >
void makVrv::DtSubjectAnnouncer< T >::slot_onActivate ( T *  subject) [protected, virtual]

Connected to its own signal_activate which adds subjects to the activated list.

template<class T >
void makVrv::DtSubjectAnnouncer< T >::slot_onDeactivate ( T *  subject) [protected, virtual]

Connected to its own signal_deactivate which removes subjects from the activated list.


Member Data Documentation

template<class T>
boost::signal<void (T*)> makVrv::DtSubjectAnnouncer< T >::signal_activate

Signal with a T argument and a void return value.

Referenced by makVrv::DtSubjectObserver< T >::connect().

template<class T>
boost::signal<void (T*)> makVrv::DtSubjectAnnouncer< T >::signal_deactivate

Signal with a DtIgDisplayUserInterface argument and a void return value.

template<class T>
ActivatedList makVrv::DtSubjectAnnouncer< T >::myActivatedList [protected]

List of activated subjects.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)