/**
 * \page BoxAlgorithm_ClockStimulator Clock stimulator
__________________________________________________________________

Detailed description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Description|
 * This box produces stimulations at specific times depending on
 * its configuration. The stimulation interval is fixed.
 *
 * It is important to underline that this box runs as fast as possible
 * thus producting empty \ref Doc_Streams_Stimulation chunks when needed.
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Description|
__________________________________________________________________

Outputs description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Outputs|
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Outputs|

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Output1|
 * This output contains the generated stimulation stream.
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Output1|
__________________________________________________________________

Settings description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Settings|
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Settings|

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Setting1|
 * The first setting \f$ i \f$ informs the box how often it should produce stimulations, with \f$ i > 0 \f$.
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Setting1|

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Setting2|
 * The second setting gives the stimulation code to trigger.
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Setting2|
__________________________________________________________________

Examples description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Examples|
 * In the designer, drag'n drop a \ref Dox_BoxAlgorithm_StimulationListener
 * and connect it to a clock stimulator box. Configure it to your preferred
 * active log level, press start and see what happens.
 *
 * The output should like this :
\verbatim
[  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 4294967296 (0x100000000) and duration 0 (0x0)
[  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 8589934592 (0x200000000) and duration 0 (0x0)
[  INF  ] <Box algorithm::Stimulation listener> For input 0 (0x0) with name Stimulation stream 1 got stimulation 33024 (0x8100)[OVTK_StimulationId_Label_00] at date 12884901888 (0x300000000) and duration 0 (0x0)
...
\endverbatim
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Examples|
__________________________________________________________________

Miscellaneous description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_ClockStimulator_Miscellaneous|
 * Notice that no stimulation is sent a time 0. The first stimulation to be sent
 * has the inter stimulation duration as date.
 * |OVP_DocEnd_BoxAlgorithm_ClockStimulator_Miscellaneous|
 */
