Parameter

Parameters set up in a EUROMOD policy-function.

Description

example

P = Parameter(Function) create a class array with the parameters of a policy Function.

This class contains the parameters specific to a EUROMOD policy function. 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 parameters of the Function class.

This class stores classes of type Extension.

This class is the superclass of the ParameterInSystem class.

Examples

collapse all

Parameter loads all the parameters configured in a Function by default.

mod = euromod("C:\EUROMOD_RELEASES_I6.0+");
P=Parameter(mod.countries("AT").policies(8).functions(end));
P  
11×1 Parameter array:

    1: Who_Must_Be_Elig | 
    2: Comp_Cond        | 
    3: Comp_perTU       | 0% of hours
    4: Comp_Cond        | 
    5: Comp_perTU       | 15% of hours
    6: Comp_Cond        | 
    7: Comp_perTU       | 45% of hours
    8: Comp_Cond        | 
    9: Comp_perTU       | 70% of hours
   10: Output_Var       | 
   11: TAX_UNIT         | 
    
    

Display a specific parameter in the Function.

P("Output_Var")  
1×1 Parameter with properties:

        comment: ""
    extensions: [0×1 Extension]
         funID: "743c8700-7db3-4711-a203-e74f7a1d61b4"
         group: ""
            ID: "a1a5f7f9-2cc2-4e79-bb1b-75e12ba6cf9b"
          name: "Output_Var"
         order: "10"
        parent: [1×1 Function]
    spineOrder: "8.27.10"
    

Input Arguments

collapse all

A specific function from the Function class array.

Data Types: class

Properties

collapse all

Returns the comment about the parameter.

Example: P(end).comment

Returns the Extension class array with extensions switches.

Example: P(end).extensions

Returns the identifier number of the function.

Example: P(end).funID

Returns the parameter group value.

Example: P(end).group

Returns the parameter identifier number.

Example: P(end).ID

Returns the name of the parameter.

Example: P(end).name

Returns the order of the parameter.

Example: P(end).order

Returns the specific Function class.

Example: P(end).parent

Returns the spine order of the parameter.

Example: P(end).spineOrder

Output Arguments

collapse all

A class array with the Function default parameters.

References

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

Extended Capabilities

Introduced in R2023a