ecl-logo Documentation

Location

Location[item]address

generates an absolute address specifying the location of item within the ECL's facilities.

Location[item,date]address

generates an absolute address specifying the location of item within the ECL's facilities on the provided date in the past.

Details

  • 'Location' can operate on any Object whose physical location is tracked in the ECL (samples, containers, instruments, parts, and plumbing items).
  • The function returns '{}' if the supplied item has no Container, or if LevelsUp->0 is specified.
  • Input
    Output
    General Options
    Messages
  • InvalidDateThe provided date, `1`, is not in the past.
    ObjectNotFoundThe object(s) `1` cannot be found in the ECL database.

Examples

Basic Examples  (2)

Find the address of a given item within the ECL (up to the Room level by default):

Find the address of a given item within the ECL at some point in the past:

Additional Examples  (1)

The function returns an empty list if the supplied item has no container:

Options  (6)

LevelsUp  (2)

Find the address of a given item up to a specified number of levels above it in the container tree:

Find the absolute address of a given item in the ECL:

NearestUp  (1)

Find the address of a given item, traversing until hitting a container of a specified Type:

Output  (3)

Return a list of associations containing location information:

Return a detailed table of location information:

Return a location string:

Behaviors  (1)

ReverseMapping  (1)

Lists of inputs are handled by the ReverseMapping behavior:

Messages  (2)

InvalidDate  (1)

If the provided date is not in the past, an error is returned:

ObjectNotFound  (1)

If any of the provided Object(s) do not exist in the database, an error is returned: