Vw-output-command
Access and save simulation results.
The VW-OUTPUT command
General Form:
(vw-output requests [keyword options])
Description
After performing a simulation using vwsim, vw-output
provides the means to access simulation results. The results can be
saved to an assocation-list in the interactive session or written to
a CSV file. For more information on the output format, see the
'Output Format' section below.
Usage and Arguments
Options Defaults
:output-file nil
:save-var nil
where all arguments, which are described below, are evaluated.
Required arguments
requests - an association-list of request types and node/device
names. See vwsim-output-request-format for the format of this
alist.
Optional arguments
:output-file - when non-NIL, the csv file to write the
requested simulation values.
:save-var - when non-NIL, the requested simulation values are
saved as an alist in the global variable specified by save-var.
Output format
When :output-file is NIL, vw-output produces an alistp. The keys in this association-list (alist) are the requested
variables in the input argument requests, converted into
strings. See vwsim-output-request-format for the syntax of
the requests input argument.
The translation of each request, which is of the form (type
. name), into a string is as follows:
(NODEV . name) => "V(name)"
(NODEP . name) => "P(name)"
(DEVV . name) => "V(name)"
(DEVI . name) => "I(name)"
(DEVP . name) => "P(name)"
In the output alist, each request will have a corresponding list
containing the request's values for each simulation time step.
When :output-file is non-NIL, the alist described above is
written to a file in the comma-separated-values (CSV) format.
