sp_include.h

Go to the documentation of this file.
00001 /** @file sp_include.h Includes all simulator plugin headers */
00002 
00003 /*
00004  **************************************************** 
00005  Convenience header file that includes all headers
00006  relevant to the simulator plugin. 
00007 
00008  (c) Thomas Moor 2008
00009  ****************************************************
00010  */
00011 
00012 
00013 #ifndef FAUDES_SP_INCLUDE_H
00014 #define FAUDES_SP_INCLUDE_H
00015 
00016 #include "sp_random.h"
00017 #include "sp_densityfnct.h"
00018 #include "sp_executor.h"
00019 #include "sp_pexecutor.h"
00020 #include "sp_lpexecutor.h"
00021 #include "sp_plpexecutor.h"
00022 #include "sp_dplpexecutor.h"
00023 #include "sp_simeventset.h"
00024 #include "sp_simconditionset.h"
00025 
00026 #endif
00027 
00028 
00029 
00030 /**
00031  
00032 @defgroup SimulatorPlugin Simulator PlugIn
00033 
00034 
00035 @ingroup AllPlugins
00036 
00037 
00038 <p>
00039 This plug-in provides classes to support the simulation of faudes generators. It is organized in
00040 a hierarchical fashion to introduce the following features:
00041 </p>
00042 
00043 - the faudes::Executor is a timed generator that tracks its current state and indicates 
00044   which events are currently enabled and/or how much time may pass
00045 - the faudes::ParallelExecutor is a vector of Executors with synchronized shared events
00046   and provides the same interface as the Executor regarding enabled events
00047 - the faudes::LoggingExecutor is a ParallelExecutor that logs state and event 
00048   data for statistical analysis
00049 - the faudes::ProposingExecutor is a LoggingExecutor that proposes which event to 
00050   execute based on stochastic event properties or priorities
00051 - the faudes::DeviceExecutor is a ProposingExecutor that synchronizes with physical time
00052   and invokes callbacks for hardware-in-the-loop simulation (IO Device plugin required)
00053 
00054 <p>
00055 The tutorial simfaudes.cpp demonstrates the use of the ProposingExecutor in a simple 
00056 interactive simulator for the synchronous product of faudes generators.
00057 </p>
00058 
00059 
00060 @section License
00061 
00062 <p>
00063 The current implementation of the simulator plugin is a re-design based 
00064 on Ruediger Berndt's and Christoph Doerr's student projects. 
00065 It is distributed with libFAUDES and under the terms of the LGPL.
00066 </p>
00067 <br>
00068 <br>
00069 <br>
00070 
00071 
00072 <p>
00073 Copyright (c) 2008, Thomas Moor.
00074 </p>
00075 
00076 
00077 */
00078 

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen