Filter by property

CLEM.Groupings.FilterByProperty

Provides a single rule to select individuals based on the properties and methods of the individuals.

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

The following parameters are used to define this activity

This provides the full list of properties and methods associated with the type of individuals in the group. The model will automatically determine the individuals' type and provide the list of available items. Methods are a similar coding style to properties, but they can also have associated arguments passed to them to assist with the calculation. Only methods that do not required arguments are available for filtering.

A full list of properties and methods are available for Individual ruminant with Labour (people) properties coming soon, but these properties can be identified in the APSIM code-base in CLEM components by the [FilterByProperty] attribute above the property definition.

Additional properties can be added as required.

The operators available include

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

This is the value the filter will use to check every individual. 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.

A blank value can only be used for the special case of setting location as "Not specified - general yards"

 

See also