| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file main.dox
|
|---|
| 10 | *
|
|---|
| 11 | * This file contains the mainpage of the documentation.
|
|---|
| 12 | *
|
|---|
| 13 | * Created on: Oct 28, 2011
|
|---|
| 14 | * Author: heber
|
|---|
| 15 | */
|
|---|
| 16 |
|
|---|
| 17 | /*! \mainpage Introduction to CodePatterns
|
|---|
| 18 | *
|
|---|
| 19 | * This is the introductory page to the CodePatterns package.
|
|---|
| 20 | *
|
|---|
| 21 | * <h1> Aim </h1>
|
|---|
| 22 | *
|
|---|
| 23 | * The CodePatterns tries to contain a good set of prefactured design patterns
|
|---|
| 24 | * for your ease-of-use. Special emphasis is placed on \a immediate usability.
|
|---|
| 25 | * In most cases, you only have to know the type of design pattern you want,
|
|---|
| 26 | * let's call it foo, then include a \b foo.hpp in your definition, a
|
|---|
| 27 | * \b foo_impl.hpp in your implementation, maybe do some inheritance and your
|
|---|
| 28 | * good to go. At times you will need to call a macro such as \b
|
|---|
| 29 | * CONSTRUCT_FOO(..) which tells the pattern about your specific class or you
|
|---|
| 30 | * have to create a \b foo.def file containing some #define's with an equal
|
|---|
| 31 | * intention. But that's supposed to be it.
|
|---|
| 32 | *
|
|---|
| 33 | * <h1> Overview of implemented patterns </h1>
|
|---|
| 34 | *
|
|---|
| 35 | * - \ref Cacheable - class wraps a value obtained via some expensive
|
|---|
| 36 | * calculation and only performs update when necessary.
|
|---|
| 37 | * - \ref Clone - class can create copies of itself with specific interface,
|
|---|
| 38 | * copies can be manipulated at construction.
|
|---|
| 39 | * - \ref Creator - class can create copies of itself with specific interface.
|
|---|
| 40 | * - \ref Factory - contains table of Creator and spawns new instances on user
|
|---|
| 41 | * request.
|
|---|
| 42 | * - \ref ManipulablePrototypeFactory - contains table of clones or prototypes
|
|---|
| 43 | * and spawns new \a manipulated instances on user request.
|
|---|
| 44 | * - \ref pattern-observer - class can observe changes in other class via this
|
|---|
| 45 | * interface.
|
|---|
| 46 | * - \ref PrototypeFactory - contains table of clones or prototypes and spawns
|
|---|
| 47 | * new instances on user request.
|
|---|
| 48 | * - \ref Registry - contains a map to instances which can be retrieved on
|
|---|
| 49 | * user request.
|
|---|
| 50 | * - \ref Singleton - global, unique instance of a class.
|
|---|
| 51 | */
|
|---|
| 52 |
|
|---|
