Object Reference : Object View and Procedure Reference : Model
  
Model
 
addassign
addinit
addover
adjust
append
block
checkbounds
clearhist
compare
control
display
displayname
drop
droplink
endog
eqs
exclude
digraph
innov
label
makeendog
makegraph
makegroup
merge
model
msg
olepush
override
printview
reinclude
replace
replacelink
replacevar
revert
scenario
scenlist
setattr
setbounds
settrace
solve
solveopt
spec
stochastic
text
trace
track
unlink
update
vars
Set of simultaneous equations used for forecasting and simulation.
Model Declaration
model declare model object.
Declare an object by entering the keyword model, followed by a name:
model mymod
declares an empty model named MYMOD. To fill MYMOD, open the model and edit the specification view, or use the append view. Note that models are not used for estimation of unknown parameters.
See also the section on model keywords in “Text View”.
Model Views
block display model block structure.
checkbounds display details for any variables that crossed boundaries during model solution.
compare show the differences between scenarios for the specified series.
display display table, graph, or spool in object window.
eqs view of model organized by equation.
digraph display the model dependency graph.
label view or set label information for the model.
msg display model solution messages.
printview show enhanced display of the mode specification.
scenlist display list description of the model scenarios.
text show text showing equations in the model.
trace view of trace output from model solution.
vars view of model organized by variable.
Model Procs
addassign assign add factors to equations.
addinit initialize add factors.
adjust prepare a variable for editing in the current scenario and/or update its values using an array expression.
addover set the active scenario add factor overrides .
append append a line of text to a model.
clearhist clear the contents of the history attribute.
control solve for values of control variable so that target matches trajectory.
displayname set display name.
drop drop equations for one or more endogenous variables in the model .
droplink drop linked objects from the model.
exclude specifies (or merges) excluded series to the active scenario.
innov solve options for stochastic simulation.
label view or set label information for the model.
makegraph make graph object showing model series.
makegroup make group out of model series and display dated data table.
merge merge objects into the model.
olepush push updates to OLE linked objects in open applications .
override specifies (or merges) override series to the active scenario.
reinclude removes one or more variables from the excluded variable list .
replace replace the text specification for an endogenous variable in the model with a new specification.
replacelink replace a linked object with a different linked object.
replacevar replace all instances of a variable in the text specification of a model with a different variable .
revert revert one or more overriden variables in the active scenario back to baseline values.
scenario set the active, alternate, or comparison scenario.
setattr set the value of an object attribute .
setbounds set upper and lower boundaries for endogenous variables during model solution.
settrace specify the endogenous variables to be traced when solving the model.
solve solve the model.
solveopt set solve options for model.
spec display the text specification view.
stochastic stochastic solution options.
trace specify endogenous variables to trace.
track specify endogenous variables to track.
unlink break links in specification.
update update model specification.
Model Data Members
Scalar values
@bounds integer containing the number of variables that crossed their boundaries during the previous solve.
String values
@attr(“arg”) string containing the value of the arg attribute, where the argument is specified as a quoted string.
@description string containing the Model object’s description (if available).
@detailedtype string with the object type: “MODEL”.
@displayname string containing the Model object’s display name. If the Model has no display name set, the name is returned.
@name string containing the Model object’s name.
@remarks string containing the Model object’s remarks (if available).
@scenarios string containing a list of scenarios in the Model.
@source string containing the Model object’s source (if available).
@type string with the object type: “MODEL”.
@units string containing the Model object’s units description (if available).
@updatetime string representation of the time and date at which the Model was last updated.
String values for Model variables
@addfactors[(“scenario”)] or @aflist[(“scenario”)]  string containing a space delimited list of the model’s addfactor variables in the specified scenario (default is Actuals).
@endoglist[(“scenario”)]  string containing a space delimited list of the model’s endogenous variables in the specified scenario (default is Actuals).
@excludelist[(“scenario”)]  string containing a space delimited list of the model’s excluded variables in the specified scenario (default is Actuals).
@exoglist[(“scenario”)]  string containing a space delimited list of the model’s exogenous variables in the specified scenario (default is Actuals).
@identity string containing a space delimited list of the model’s endogenous variables determined by identities.
@overridelist[(“scenario”)] or @olist[(“scenario”)]  string containing a space delimited list of the model’s variables set as overrides in the specified scenario (default is Actuals).
@linklist string containing space delimited list of all linked objects in the model
@spec(“variable”) string containing the estimation object name or text specification of the equation determining the specified endogenous variable, or an empty string if “variable” is an invalid name.
@stochastic string containing a space delimited list of stochastic endogenous variables.
@varlist[(“scenario”)]  string containing a space delimited list of all the model’s variables for the specified scenario (default is Actuals).
In addition to a scenario name, you may specify “@active” (in quotes) to specify the current active scenario or “@alternate” to specify the current alternative scenario.
Model Examples
The commands:
model mod1
mod1.append y=324.35+x
mod1.append x=-234+7.3*z
mod1.solve(m=100,c=.008)
create, specify, and solve the model MOD1.
The command:
mod1(g).makegraph gr1 x y z
plots the endogenous series X, Y, and Z, in the active scenario for model MOD1.