trick/trick_source/sim_services/Clock/docs/design.dox_in
Alex Lin 19025d77ad Standardize directory names
Reorganized.  Created a new top level include directory that will hold all of Trick's header files. Moved all of the Trick headers to this directory.  Created a libexec directory that holds all of the executables that users don't need to execute directly.  Changed all of the executables remaining in bin to start with "trick-".  In the sim_services directories changed all source files to find the Trick headers in their new location.  Since all of the include files are gone in sim_services, removed the src directories as well, moving all of the source files up a level.  Moved the makefiles, docs, man, and other architecture independent files into a top level share directory.  Renamed lib_${TRICK_HOST_CPU} to lib64 or lib depending on the platform we're currently on.

refs #63
2015-06-09 08:44:42 -05:00

51 lines
1.5 KiB
Plaintext

/**
@page LEVEL2 Real-Time Clock Design
@section LEVEL3 Base Real-Time Clock
The base Clock object provides an interface for the following operations. The
base Clock does not implement the following operations.
-# Initializing the clock hardware
-# Resetting the clock (setting the reference time)
-# Getting the current real time
-# Spinning on the clock<br>
Spinning on the clock means to continually check the clock waiting for real-time to
catch up to the desired simulation elapsed time.
-# Stopping the clock
@section LEVEL3 Gettimeofday Clock
The GetTimeOfDayClock is a clock object that derives from the the Base Real-Time Clock. The
GetTimeOfDayClock uses system clock as the real-time clock.
The GetTimeOfDayClock implements the interface laid out by the base clock class
@section LEVEL4 Initializing the Clock
@copydetails Trick::GetTimeOfDayClock::clock_init()
Trick::GetTimeOfDayClock::clock_init()
@section LEVEL4 Resetting the Clock (setting the reference time)
@copydetails Trick::GetTimeOfDayClock::clock_reset()
Trick::GetTimeOfDayClock::clock_reset()
@section LEVEL4 Getting the Current Real Time
@copydetails Trick::GetTimeOfDayClock::clock_time()
Trick::GetTimeOfDayClock::clock_time()
@section LEVEL4 Spinning on the Clock
@copydetails Trick::GetTimeOfDayClock::clock_spin()
Trick::GetTimeOfDayClock::clock_spin()
@section LEVEL4 Stopping the Clock
@copydetails Trick::GetTimeOfDayClock::clock_stop()
Trick::GetTimeOfDayClock::clock_stop()
*/