SimTick.h File Reference

#include <stddef.h>
#include "colony_config.h"
#include "Cpl/System/Semaphore.h"
#include "Cpl/Container/Item.h"

Include dependency graph for SimTick.h:

Go to the source code of this file.

Classes
class	Cpl::System::SimTick
	This class define the interface to provide a simulates system tick (in milliseconds) to the application. More...

Namespaces
namespace	Cpl
	The 'Cpl' namespace is the root name space for the Colony.
namespace	Cpl::System
	The System namespace contains platform independent foundation abstractions and classes related to program execution.

Macros
#define	OPTION_CPL_SYSTEM_SIM_TICK_MIN_TICKS_FOR_ADVANCE   10
	Minimum number of ticks required to advance the simulated time.
#define	OPTION_CPL_SYSTEM_SIM_TICK_YEILD_SLEEP_TIME   1
	Value passed to the Cpl::System::sleep() call to effectively yield the CPU do allow the threads running in simulated time to actually begin executing.
#define	CPL_SYSTEM_SIM_TICK_TOP_LEVEL_WAIT()
	Simulate Tick disabled.
#define	CPL_SYSTEM_SIM_TICK_APPLICATION_WAIT()
	Simulate Tick disabled.
#define	CPL_SYSTEM_SIM_TICK_USING_SIM_TICKS()   false
	Simulate Tick disabled.
#define	CPL_SYSTEM_SIM_TICK_THREAD_INIT_(f)
	Simulate Tick disabled.
#define	CPL_SYSTEM_SIM_TICK_REAL_TIME_THREAD_INIT_()
	Simulate Tick disabled.
#define	CPL_SYSTEM_SIM_TICK_ON_THREAD_EXIT_()
	Simulate Tick disabled.

Macro Definition Documentation

CPL_SYSTEM_SIM_TICK_APPLICATION_WAIT

#define CPL_SYSTEM_SIM_TICK_APPLICATION_WAIT

(

)

Simulate Tick disabled.

CPL_SYSTEM_SIM_TICK_ON_THREAD_EXIT_

#define CPL_SYSTEM_SIM_TICK_ON_THREAD_EXIT_

(

)

Simulate Tick disabled.

CPL_SYSTEM_SIM_TICK_REAL_TIME_THREAD_INIT_

#define CPL_SYSTEM_SIM_TICK_REAL_TIME_THREAD_INIT_

(

)

Simulate Tick disabled.

CPL_SYSTEM_SIM_TICK_THREAD_INIT_

#define CPL_SYSTEM_SIM_TICK_THREAD_INIT_

(

f

)

Simulate Tick disabled.

CPL_SYSTEM_SIM_TICK_TOP_LEVEL_WAIT

#define CPL_SYSTEM_SIM_TICK_TOP_LEVEL_WAIT

(

)

Simulate Tick disabled.

CPL_SYSTEM_SIM_TICK_USING_SIM_TICKS

#define CPL_SYSTEM_SIM_TICK_USING_SIM_TICKS

(

)

false

Simulate Tick disabled.

OPTION_CPL_SYSTEM_SIM_TICK_MIN_TICKS_FOR_ADVANCE

#define OPTION_CPL_SYSTEM_SIM_TICK_MIN_TICKS_FOR_ADVANCE   10

Minimum number of ticks required to advance the simulated time.

This parameter is a work-around for a non-Real Time OS (such as Windoze) which can not actually sleep/wait for 1msec. The parameter is defaulted to 10, i.e. after the simulation has been advance 10 tick -->the simulated time will be advanced 10msec.

NOTE: The parameter also allows the simulation to be "speed-up" if the timing requirements of the application under test do not require millisecond resolution, e.g. setting this value to 1000 (aka 1 second) the simulation runs MUCH faster than real time

OPTION_CPL_SYSTEM_SIM_TICK_YEILD_SLEEP_TIME

#define OPTION_CPL_SYSTEM_SIM_TICK_YEILD_SLEEP_TIME   1

Value passed to the Cpl::System::sleep() call to effectively yield the CPU do allow the threads running in simulated time to actually begin executing.