Class: cgv.CGV
Package: cgv
Execute CGV object
result
= cgvObj
.run()
executes
the model once for each input data that you added to the object. result
= cgvObj
.run()
is
a boolean value that indicates whether the run completed without execution
error. result
is a handle
to a cgvObj
cgv.CGV
object.
After each execution of the model, the object captures and writes the following metadata to a file in the output folder:
ErrorDetails — If errors occur,
the error information. |
status — The execution status. |
ver — Version information for MathWorks® products. |
hostname — Name of computer. |
dateTime — Date and time of execution. |
warnings — If warnings occur, the
warning messages. |
username — Name of user. |
runtime — The amount of time that
lapsed for the execution. |
Only call run
once for each cgv.CGV
object.
The cgv.CGV methods that set up the object are ignored
after a call to run
. See the cgv.CGV
for
details.
You can call run
once without first calling
addInputData
. However, it
is recommended that you first save the required data for execution to a
MAT-file, including the model inputs and parameters. Then use addInputData
to pass the MAT-file to the CGV object
before calling run
.
The cgv.CGV
object supports callback
functions that you can define and add to the cgv.CGV
object.
These callback functions are called during cgv.CGV.run()
in
the following order:
Callback function | Add to object using... | cgv.CGV.run() executes
callback function... |
---|---|---|
HeaderReportFcn | addHeaderReportFcn | Before executing input data in cgv.CGV |
PreExecReportFcn | addPreExecReportFcn | Before executing each input data file in cgv.CGV |
PreExecFcn | addPreExecFcn | Before executing each input data file in cgv.CGV |
PostExecReportFcn | addPostExecReportFcn | After executing each input data file in cgv.CGV |
PostExecFcn | addPostExecFcn | After executing each input data file in cgv.CGV |
TrailerReportFcn | addTrailerReportFcn | After the input data is executed in cgv.CGV |