Fawkes API Fawkes Development Version
clock.cpp
1
2/***************************************************************************
3 * clock.cpp - Clock aspect for Fawkes
4 *
5 * Created: Tue Jun 12 22:30:33 2007
6 * Copyright 2007 Daniel Beck
7 * 2007-2010 Tim Niemueller [www.niemueller.de]
8 *
9 ****************************************************************************/
10
11/* This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version. A runtime exception applies to
15 * this software (see LICENSE.GPL_WRE file mentioned below for details).
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
21 *
22 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
23 */
24
25#include <aspect/clock.h>
26
27namespace fawkes {
28
29/** @class ClockAspect <aspect/clock.h>
30 * Thread aspect that allows to obtain the current time from the clock.
31 * Threads that need to deal with the current time should have this aspect
32 * and not obtain the time by means of gettimeofday!
33 *
34 * @ingroup Aspects
35 * @author Daniel Beck
36 */
37
38/** @var Clock ClockAspect::clock
39 * By means of this member access to the clock is given.
40 */
41
42/** Constructor. */
44{
45 add_aspect("ClockAspect");
46}
47
48/** Virtual empty destructor. */
50{
51}
52
53/** Set the clock.
54 * It is guaranteed that this is called for a clock thread before
55 * Thread::start() is called (when running regularly inside Fawkes).
56 * @param clock Clock instance to use.
57 */
58void
60{
61 this->clock = clock;
62}
63
64} // end namespace fawkes
void add_aspect(const char *name)
Add an aspect to a thread.
Definition: aspect.cpp:49
void init_ClockAspect(Clock *clock)
Set the clock.
Definition: clock.cpp:59
ClockAspect()
Constructor.
Definition: clock.cpp:43
Clock * clock
By means of this member access to the clock is given.
Definition: clock.h:42
virtual ~ClockAspect()
Virtual empty destructor.
Definition: clock.cpp:49
This is supposed to be the central clock in Fawkes.
Definition: clock.h:35
Fawkes library namespace.