access
(Model)
Access properties of Model objects
Syntax
output = access(model, what)
output = model{what}
Input arguments
model
[ Model ]
Model objects that will be queried about
what
.
what
[ string ]
One of the valid queries into the model object properties listed below.
Output arguments
output
[ * ]
Response to the query about
what
.
Valid queries
"file-name"
Returns a string, or an array of strings, with the name(s) of model source files on which this model objects is based.
"transition-variables"
"transition-shocks"
"measurement-variables"
"measurement-shocks"
"parameters"
"exogenous-variables"
Return a string array of all the names of the respective type in order of their apperance in the declaration sections of the source model file(s).
"log-variables"
Returns the list of variables declared as
!log-variables
.
"log-status"
Returns a struct with
true
for all variables declared as!log-variables
andfalse
for all other variables.
"names-descriptions"
Returns a struct with the desriptions strings for all model quantities (variables, shocks, parameters).
"transition-equations"
"measurement-equations"
"measurement-trends"
"links"
Returns a vector of strings with all equations of the respective type.
"equations-descriptions"
Returns a struct with the desriptions strings for all model equations, ordered as follows: measurement equations, transition equations, measurement trends, links.
"preprocessor"
, "postprocessor"
Returns an array of Explanatory objects with the equations defined in thea
!preprocessor
or!postprocessor
section of the model source.
"parameter-values"
Returns a struct of all parameter values (not including std deviations or cross-correlation coefficients).
"std-values"
Returns a struct of std deviations for all model shocks (transitory and measurement).
"corr-values"
Returns a struct of cross-correlation coefficients for all pairs of transition shocks and all pairs of measurement shocks.
"nonzero-corr-values"
Returns a struct of non-zero cross-correlation coefficients for all pairs of transition shocks and all pairs of measurement shocks.
"steady-level"
Returns a struct with the steady-state levels of all model variables.
"steady-change"
Returns a struct with the steady-state change (first difference or rate of change depending on the log status of each variables) for all model variables.
"initials"
Returns a vector of strings listing all initial conditions necessary for a dynamic simulation.
"stable-roots"
"unit-roots"
"unstable-roots"
Returns a vector of stable, unit o unstable eigenvalues, respectively.
"max-lag"
"max-lead"
Returns the max lag or max lead occurring in the model equations.
"stationary-status"
Returns a struct with
true
for all stationary variables, andfalse
for all nonstationary variables.
"transition-vector"
"measurement-vector"
"shocks-vector"
Returns a list of strings with the respective variables or shocks, including auxiliary lags and leads, as they appear in the rows of first order solution matrices.
"forward-horizon"
Horizon for which the forwared expansion of the model solution has been calculated and is available in the model object.