Commit 810103a9 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Update manual with shared_ptr

parent 3c3caa6f
Pipeline #577065 passed with stages
in 4 minutes and 59 seconds
...@@ -210,7 +210,7 @@ In addition to the constructor, each module can override the following methods: ...@@ -210,7 +210,7 @@ In addition to the constructor, each module can override the following methods:
\begin{itemize} \begin{itemize}
\item \parameter{initialise()}: Called after loading and constructing all modules and before starting the analysis loop. \item \parameter{initialise()}: Called after loading and constructing all modules and before starting the analysis loop.
This method can for example be used to initialize histograms. This method can for example be used to initialize histograms.
\item \parameter{run(Clipboard* clipboard)}: Called for every time frame or triggered event to be analyzed in the simulation. The argument represents a pointer to the clipboard where the event data is stored. \item \parameter{run(std::shared_ptr<Clipboard> clipboard)}: Called for every time frame or triggered event to be analyzed in the simulation. The argument represents a pointer to the clipboard where the event data is stored.
A status code is returned to signal the framework whether to continue processing data or to end the run. A status code is returned to signal the framework whether to continue processing data or to end the run.
\item \parameter{finalise()}: Called after processing all events in the run and before destructing the module. \item \parameter{finalise()}: Called after processing all events in the run and before destructing the module.
Typically used to save the output data (like histograms). Typically used to save the output data (like histograms).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment