Methods and Properties - By Category

Alphabetical List By Category
euromod Load the EUROMOD microsimulation model.

Country class

Properties

datasets Get the Country datasets.
extensions Get the Model and Country extensions.
local_extensions Get the Country extensions.
name Get the Country two-letters country code.
parent Get the Model base class.
policies Get the Country policies.
systems Get the Country systems.

Methods

info Get information on model objects.
run Run EUROMOD simulations.

Dataset class

Properties

coicopVersion Get the Dataset the COICOP version.
comment Get the Dataset comment.
currency Get the Dataset currency.
decimalSign Get the decimal delimiter of the values.
datasets Get the Dataset datasets .
ID Get the Dataset identifier number.
listStringOutVar Get the names of returned variables.
name Get the Dataset name.
parent Get the parent Country class.
private Get the Dataset access type.
readXVariables Get the loaded variables
useCommonDefault Get the use default common.
yearCollection Get the Dataset year.
yearInc Get the year of income variables.

Methods

info Get information on Dataset objects.

DatasetInSystem class

Properties

bestMatch Get the DatasetInSystem best-match information.
coicopVersion Get the DatasetInSystem the COICOP version.
comment Get the DatasetInSystem comment.
currency Get the DatasetInSystem currency.
dataID Get the parent Dataset identifier number.
decimalSign Get the decimal delimiter of the values.
ID Get the DatasetInSystem identifier number.
listStringOutVar Get the names of returned variables.
name Get the DatasetInSystem name.
parent Get the parent System class.
private Get the DatasetInSystem access type.
readXVariables Get the loaded variables
sysID Get the parent System identifier number.
useCommonDefault Get the use default common.
yearCollection Get the DatasetInSystem year.
yearInc Get the year of income variables.

Methods

info Get information on DatasetInSystem objects.

Extension class

Properties

ID Get the Extension identifier number.
name Get the Extension name.
parent Get the parent Country class.
shortName Get the Extension short name.

Function class

Properties

comment Get the Function comment.
extensions Get the Function extensions.
ID Get the Function identifier number.
name Get the Function name.
order Get the Function order.
parameters Get the Function parameters.
parent Get the parent Policy class.
polID Get the parent Policy identifier number.
private Get the Function access type.
spineOrder Get the Function order in the spine.

Methods

info Get information on Function objects.

FunctionInSystem class

Properties

comment Get the FunctionInSystem comment.
extensions Get the FunctionInSystem extensions.
funID Get the parent Function identifier number.
ID Get the FunctionInSystem identifier number.
name Get the FunctionInSystem name.
order Get the FunctionInSystem order.
parameters Get the FunctionInSystem parameters.
parent Get the parent PolicyInSystem class.
polID Get the parent Policy identifier number.
private Get the FunctionInSystem access type.
spineOrder Get the FunctionInSystem order in the spine.
Switch Get the FunctionInSystem extension switch.
sysID Get the parent System identifier number.

Methods

info Get information on FunctionInSystem objects.

Model class

Properties

countries Get the Model countries.
extensions Get the Model extensions.
modelpath Get the path to the EUROMOD project.

Methods

info Get information on model objects.
run Run EUROMOD simulations.

Parameter class

Properties

comment Get the Parameter comment.
extensions Get the Parameter extensions.
funID Get the parent Function identifier number.
group Get the Parameter group.
ID Get the Parameter identifier number.
name Get the Parameter name.
order Get the Parameter order.
parent Get the parent Function class.
polID Get the parent Policy identifier number.
spineOrder Get the Parameter order in the spine.

Methods

info Get information on Parameter objects.

ParameterInSystem class

Properties

comment Get the ParameterInSystem comment.
extensions Get the ParameterInSystem extensions.
funID Get the parent Function identifier number.
group Get the ParameterInSystem group.
ID Get the ParameterInSystem identifier number.
name Get the ParameterInSystem name.
order Get the ParameterInSystem order.
parent Get the parent FunctionInSystem class.
parID Get the parent Parameter identifier number.
spineOrder Get the ParameterInSystem order in the spine.
sysID Get the parent System identifier number.
value Get the ParameterInSystem value.

Methods

info Get information on ParameterInSystem objects.

Policy class

Properties

comment Get the Policy comment.
extensions Get the Policy extensions.
functions Get the Policy functions.
ID Get the Policy identifier number.
name Get the Policy name.
order Get the Policy order.
parent Get the parent Country class.
private Get the Policy access type.
spineOrder Get the Policy order in the spine.

Methods

info Get information on Policy objects.

PolicyInSystem class

Properties

comment Get the PolicyInSystem comment.
extensions Get the PolicyInSystem extensions.
functions Get the PolicyInSystem functions.
ID Get the PolicyInSystem identifier number.
name Get the PolicyInSystem name.
order Get the PolicyInSystem order.
parent Get the parent System class.
polID Get the parent Policy identifier number.
private Get the PolicyInSystem access type.
spineOrder Get the PolicyInSystem order in the spine.
Switch Get the PolicyInSystem extension switch.
sysID Get the parent System identifier number.

Methods

info Get information on PolicyInSystem objects.

ReferencePolicy class

Properties

extensions Get the ReferencePolicy extensions.
ID Get the ReferencePolicy identifier number.
name Get the ReferencePolicy name.
order Get the ReferencePolicy order.
parent Get the parent Country class.
refPolID Get the parent Policy identifier number.
spineOrder Get the ReferencePolicy order in the spine.

Methods

info Get information on ReferencePolicy objects.

Simulation class

Properties

errors Get the errors and warnings from Simulation.
outputs Get the Simulation output. See run().
output_filenames Get the file-names of Simulation outputs.
settings Get the Simulation configuration settings.

System class

Properties

bestmatchDatasets Get the best-match datasets for the system.
comment Get the Model and System comment.
currencyOutput Get the currency of the simulation results.
currencyParam Get the currency of the monetary parameters in the system.
datasets Get the System datasets .
ID Get the System identifier number.
headDefInc Get the main income definition.
name Get the System name.
order Get the System order.
parent Get the parent Country class.
policies Get the System policies.
private Get the System access type.
year Get the System year.

Methods

info Get information on System objects.
run Run EUROMOD simulations.