last updated 19 June 2019
  • All Files

Labour filter

CLEM.Groupings.LabourFilter

Provides a single rule to select individuals in a Labour filter group

ClosedDescription

A labour filter is a component used to define a single rule for selecting individuals to be included in a Labour filter group. It comprises of the Labour parameter to be used, an operator (e.g. equals or is less than) and the value to compare with.

ClosedParameters

The following parameters are used to define this activity

ClosedParameter

The name of the parameter to be used is provided in the list of LabourFilterParameters and includes.

  • Name (The name given to the Labour Type in the simulation tree)
  • Gender
  • Age
  • Hired

New parameters can be added by the developers based on future requirements.

Warning. When you provide more than 1 individual in the Labour type, the model will create a number of Labour Types in the background based on the Name of the Labour Type and an index (e.g. Male_1, Male_2...). This means that you will NOT be able to use the Name parameter in this Labour filter as there will be no matches. We suggest you use Gender and Age filters rather than Name filters as they better represent individuals ageing over time.

ClosedOperator

The operators available include

  • Equal to
  • Not equal to
  • Less than
  • Less than or equal to
  • Greater than
  • Greater than or equal to
ClosedValue

This is the value the filter will use to check every individual in the herd. If the rule is true for any individual it will be included in the group.

The value supplied will depend upon the type of parameter being checked. For example some parameters are boolean types and for these you provide TRUE or FALSE, while string parameters use text and numeric parameters will use a number.

 

See also