ReferencePolicy

Reference policies modeled in a EUROMOD country.

Description

example

P = ReferencePolicy(Country) create a class array with the reference policies of a Country.

This class contains the reference policies implemented in a EUROMOD country model. The class elements can be accessed by indexing the class array with an integer, or a string value of any class property (e.g. name, ID, order, etc.).

This class is stored in the property policies of the Country class.

This class stores classes of type Extension.

Examples

collapse all

ReferencePolicy loads all the reference policies configured in a Country by default.

mod = euromod("C:\EUROMOD_RELEASES_I6.0+");
P=ReferencePolicy(mod.countries("AT"));
P  
25×1 ReferencePolicy array:

    1: bch00_at | BEN: Main child benefit (Familienbeihilfe)
    2: tscee_at | SIC: social insurance contributions employee (Arbeitnehmerbeitraege zur Sozialversicherung)
    3: tin_at   | TAX: income tax (Einkommenssteuer)
    4: bunct_at | BEN: unemployment benefit (Arbeitslosengeld) (PART SIMULATED)
    5: bunnc_at | BEN: Unemployment assistance (Notstandshilfe)
    6: pmmtu_at | BEN: minimum pension top-up (Ausgleichszulage) - turn on pch00_at for full simulation
    7: pcstu_at | BEN: minimum pension top-up for civil servants (Ergaenzungszulage) - turn on pch00_at for full simulation
    8: tscpe_at | SIC: social insurance contributions pensioner (Beitraege zur Sozialversicherung fuer Rentner)
    9: bmact_at | BEN: Maternity allowance
   10: tin_at   | TAX: income tax (Einkommenssteuer)
   11: bch00_at | BEN: Main child benefit (Familienbeihilfe)
       
    

Display a specific reference policy in the Country.

P(2)  
1×1 ReferencePolicy with properties:

          refPolID: "bc68928e-d226-466f-a1be-3523e08e7aa1"
        extensions: [0×1 Extension]
                ID: "bc68928e-d226-466f-a1be-3523e08e7aa1"
              name: "tscee_at"
             order: "27"
            parent: [1×1 Country]
        spineOrder: "27"
    

Input Arguments

collapse all

A specific country from the Country class array.

Data Types: class

Properties

collapse all

Returns the Extension class array with extensions switches.

Example: P(end).extensions

Returns the reference policy identifier number.

Example: P(end).ID

Returns the name of the reference policy.

Example: P(end).name

Returns the order of the reference policy.

Example: P(end).order

Returns the specific Country class.

Example: P(end).parent

Returns the identifier number of the policy at the Country level.

Example: P(end).refPolID

Returns the spine order of the reference policy.

Example: P(end).spineOrder

Output Arguments

collapse all

A class array with the Country default reference policies.

References

[1] Documentation EUROMOD - Tax-benefit microsimulation model for the European Union.

Extended Capabilities

Introduced in R2023a