From f2849cb25a447433bb014b9eb42eefc03d809928 Mon Sep 17 00:00:00 2001
From: Roselyne Chotin <Roselyne.Chotin-Avot@lip6.fr>
Date: Thu, 9 Aug 2012 16:41:47 +0000
Subject: [PATCH] documentation for stimuli

---
 stratus1/doc/stratus/man_stimuli.tex | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 stratus1/doc/stratus/man_stimuli.tex

diff --git a/stratus1/doc/stratus/man_stimuli.tex b/stratus1/doc/stratus/man_stimuli.tex
new file mode 100644
index 00000000..21eb08d6
--- /dev/null
+++ b/stratus1/doc/stratus/man_stimuli.tex
@@ -0,0 +1,13 @@
+The stimuli used for the simulation are described in a \verb-Stimuli- method. This method is a Python function generator that is automatically called by the \verb-Testbench- method to generate all the stimuli. As a Python function generator, the \verb-yield- instruction have to be used at the end of each stimuli computation.
+
+\subsubsection{Affect value to signals}
+The method \verb-affect- permits to affect a value to a given signal as follow
+\begin{verbatim}
+self._stim.affect(self.Ck,0)
+\end{verbatim}
+
+\subsubsection{Add stimuli}
+The method \verb-add- permits to finish a step of simulation by add all the values to the current stimuli
+\begin{verbatim}
+self._stim.add()
+\end{verbatim}