Changeset b760ac5 for src/documentation

Timestamp:

Dec 13, 2011, 12:02:21 PM (14 years ago)

Author:

Frederik Heber <heber@…>

Children:

3324cf

Parents:

d85532

git-author:

Frederik Heber <heber@…> (12/02/11 13:13:44)

git-committer:

Frederik Heber <heber@…> (12/13/11 12:02:21)

Message:

Relay can now also relay notifications.

• NOTE: We do not yet notify the Observables, whose update() we combine, when the Relay is destroyed. They have to signOff before by themselves (or by some other means, e.g. be destroyed before.).

File:

• src/documentation/patterns/observer.dox (modified) (1 diff)

src/documentation/patterns/observer.dox

@@ -28 +28 @@
  * updating many of its internal sub-observables. This means the update is not passed, if
  * it is produced while the main-observable itself is within any Observation block.
+ *
+ * \section pattern-observer-howtos Howto
+ *
+ *  Below you find various howtos to guide you through how to use the various
+ *  observer patterns.
+ *
+ * \section pattern-observer-howtos-observer Observers
+ *
+ *  \todo write howto for using an Observer
+ *
+ * \section pattern-observer-howtos-observables Observables
+ *
+ *  \todo write howto for using an Observable
+ *
+ * \section pattern-observer-howtos-relay Relays
+ *
+ *  Lets us assume that you want to observe all instances of class "foo".
+ *  In order to create a Relay you have to do the following:
+ *  -# Create a new class "bar" that inherits the Relay pattern.
+ *  \code
+ *    #include "CodePatterns/Relay.hpp"
+ *    class bar : public Relay {
+ *    ...
+ *    };
+ *  \endcode
+ *  -# In the constructor bar::bar() create a Channels object for your Relay and
+ *     add a channel for each of foo's channels, use foo's enum for this:
+ *   \code
+ *     bar::bar() {
+ *      Channels *OurChannel = new Channels();
+ *      NotificationChannels.insert( std::make_pair(this, OurChannel) );
+ *      OurChannel->addChannel(foo::Notification1);
+ *      OurChannel->addChannel(foo::Notification2);
+ *      ...
+ *     }
+ *   \endcode
+ *   -# Someplace else you have add all Observers that need to check on all
+ *      instances of "foo" to be signed on.
+ *    \code
+ *    bar barInstance;
+ *    ... someObserverInstance;
+ *    barInstance.signOn(someObserverInstance);
+ *    \endcode
+ *   -# ... or maybe just for a specific channel of foo.
+ *    \code
+ *    bar barInstance;
+ *    ... someObserverInstance;
+ *    barInstance.signOn(someObserverInstance, foo::Notification1);
+ *    \endcode
+ *
+ *
+ * \date 2011-12-01
  */