Filter by attribute

CLEM.Groupings.FilterByAttribute

Provides a single rule to select individuals based on an attribute that has been applied to the individual

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

The following parameters are used to define this activity

Each attribute added to an individual is identified by a tag (or label) and may also contain an associated value. This property identifies the attribute for filtering.

As attributes are added to individuals by activities an individual may or may not have a particular attribute. This style will use the boolean check of whether the attribute exists on each individual.

When an attribute is missing from an individual in the list, exists will be false (0).

You can perform filtering on the value (floating point number) associated with the attribute identified by the tag set above. If the activity does not exist an empty value (0) is returned.

It is assumed that individuals with the specified attribute missing do not meet the filter criteria and will therefore be excluded from the individuals filtered.

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 against the named attribute for every individual. If the rule is true for any individual it will be included in the group.

The value supplied will depend upon the style selected above with TRUE or FALSE needed for checking if the attribute exists and a floating point number needed for comparing with the associated attribute value.

 

See also