ParameterInSystem

Parameters set up in a function of the EUROMOD specific system.

collapse all in page

Syntax

P = ParameterInSystem(FunctionInSystem)

Description

example

P = ParameterInSystem(FunctionInSystem) create a class array with the parameters defined in a function at the system level.

This class contains the parameters specific to a system in the 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 FunctionInSystem class.

This class stores classes of type Extension.

This class inherits methods and properties from the superclass Parameter.

Examples

collapse all

Open Live Script

ParameterInSystem loads all the parameters configured in a Function and implemented in a System by default.

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

    1: Who_Must_Be_Elig |              | one
    2: Comp_Cond        |              | (i_mc_rand_3 <= $sh_0hours_ee)
    3: Comp_perTU       | 0% of hours  | 0
    4: Comp_Cond        |              | (i_mc_rand_3 >$sh_0hours_ee & i_mc_rand_3<= $sh_15hours_ee)
    5: Comp_perTU       | 15% of hours | 0.15
    6: Comp_Cond        |              | (i_mc_rand_3 >$sh_15hours_ee & i_mc_rand_3<= $sh_45hours_ee)
    7: Comp_perTU       | 45% of hours | 0.45
    8: Comp_Cond        |              | (i_mc_rand_3 >$sh_45hours_ee)
    9: Comp_perTU       | 70% of hours | 0.70
   10: Output_Var       |              | lhwsr_s
   11: TAX_UNIT         |              | tu_individual_at

Display a specific parameter in the FunctionInSystem.

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

        parID: "a1a5f7f9-2cc2-4e79-bb1b-75e12ba6cf9b"
        value: "lhwsr_s"
        sysID: "064cf5eb-73bd-4fae-a421-ed9781e418c9"
      comment: ""
   extensions: [0×1 Extension]
        funID: "743c8700-7db3-4711-a203-e74f7a1d61b4"
        group: ""
           ID: "064cf5eb-73bd-4fae-a421-ed9781e418c9a1a5f7f9-2cc2-4e79-bb1b-75e12ba6cf9b"
         name: "Output_Var"
        order: "10"
       parent: [1×1 FunctionInSystem]
   spineOrder: "8.27.10"

Input Arguments

collapse all

A specific function from the FunctionInSystem 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 at country level.

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 FunctionInSystem class.

Example: P(end).parent

Returns the identifier number of the parameter at Country level.

Example: P(end).parID

Returns the spine order of the parameter.

Example: P(end).spineOrder

Returns the identifier number of the system.

Example: P(end).sysID

Returns the value of the parameter.

Example: P(end).value

Output Arguments

collapse all

A class array with the FunctionInSystem default parameters.

References

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

Extended Capabilities

See Also

Introduced in R2023a