fawkes::TimeSourceAspect Class Reference
[Fawkes Thread Aspects]

Thread aspect that allows to provide a time source to the Fawkes clock. More...

#include <aspect/time_source.h>

List of all members.

Public Member Functions

 TimeSourceAspect (TimeSource *timesource) __attribute__((nonnull))
 Constructor.
virtual ~TimeSourceAspect ()
 Virtual empty destructor.
TimeSourceget_timesource () const
 Get time source.


Detailed Description

Thread aspect that allows to provide a time source to the Fawkes clock.

There may be at most one external time source provided by a thread with the TimeSourceAspect at any given time. This is ensured by aspect initializer. This aspect can be used for example to attach Fawkes to a simulator and provide the simulated time to the system.

Author:
Tim Niemueller

Definition at line 31 of file time_source.h.


Constructor & Destructor Documentation

fawkes::TimeSourceAspect::TimeSourceAspect ( TimeSource timesource  ) 

Constructor.

Parameters:
timesource the time source to provide to Fawkes

Definition at line 44 of file time_source.cpp.

fawkes::TimeSourceAspect::~TimeSourceAspect (  )  [virtual]

Virtual empty destructor.

Definition at line 50 of file time_source.cpp.


Member Function Documentation

TimeSource * fawkes::TimeSourceAspect::get_timesource (  )  const

Get time source.

This method is called by the aspect initializer to get the time source the thread with this aspect provides.

Returns:
time source provided by the thread with this aspect

Definition at line 61 of file time_source.cpp.

Referenced by fawkes::AspectIniFin::finalize(), and fawkes::AspectIniFin::init().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:45 2011 for Fawkes API by  doxygen 1.4.7