Craig Dowell
f3c68e4a74
--HG-- rename : doc/tutorial/Makefile => doc/tutorial/in-process/Makefile rename : doc/tutorial/attributes.texi => doc/tutorial/in-process/attributes.texi rename : doc/tutorial/figures/README => doc/tutorial/in-process/figures/README rename : doc/tutorial/figures/dumbbell.dia => doc/tutorial/in-process/figures/dumbbell.dia rename : doc/tutorial/figures/helpers.obj => doc/tutorial/in-process/figures/helpers.obj rename : doc/tutorial/figures/oneobj.png => doc/tutorial/in-process/figures/oneobj.png rename : doc/tutorial/figures/pp.dia => doc/tutorial/in-process/figures/pp.dia rename : doc/tutorial/figures/star.dia => doc/tutorial/in-process/figures/star.dia rename : doc/tutorial/figures/threeobj.png => doc/tutorial/in-process/figures/threeobj.png rename : doc/tutorial/helpers.texi => doc/tutorial/in-process/helpers.texi rename : doc/tutorial/introduction.texi => doc/tutorial/in-process/introduction.texi rename : doc/tutorial/log.texi => doc/tutorial/in-process/log.texi rename : doc/tutorial/other.texi => doc/tutorial/in-process/other.texi rename : doc/tutorial/output.texi => doc/tutorial/in-process/output.texi rename : doc/tutorial/statistics.texi => doc/tutorial/in-process/statistics.texi rename : doc/tutorial/troubleshoot.texi => doc/tutorial/in-process/troubleshoot.texi rename : doc/tutorial/tutorial.css => doc/tutorial/in-process/tutorial.css rename : doc/tutorial/tutorial.texi => doc/tutorial/in-process/tutorial.texi
21 lines
826 B
Plaintext
21 lines
826 B
Plaintext
@node Helper Functions
|
|
@chapter Helper Functions
|
|
@anchor{chap:Helpers}
|
|
This chapter describes an intermediate API for the simulator; what we
|
|
call the "helper API". The helper API is implemented in
|
|
@code{src/helper/} directory; it depends on (and wraps) the low-level
|
|
API which is implemented everywhere else in @code{src/}. The following
|
|
figure shows this relationship.
|
|
@center @image{figures/helpers,,,,png}
|
|
|
|
The use of the helper API is optional. It has two main goals:
|
|
@itemize @bullet
|
|
@item Provide "syntactic sugar" to wrap a number of related low-level
|
|
API calls together, that would normally be grouped together often, into
|
|
something that is more user-friendly.
|
|
@item Handle configuration of larger topological units (e.g., a set
|
|
of nodes or a set of nodes on a particular link) .
|
|
@end itemize
|
|
|
|
(more to follow)
|