This function evaluates to a list of linked downstream objects that are between two specified objects, inclusive.
Type
LIST {OBJECT}
Arguments
Type
Meaning
1
OBJECT
The upstream object at which to start the search
2
OBJECT
The downstream object at which to finish the search
Evaluation
ListDownstreamObjects searches links downstream from the first object until it finds the second object. It returns a list of all objects that it finds, inclusive of the specified objects.
Comments
Notes / Limitations to this function:
To find the next downstream object, the function traverses links from main channel outflow slots. These slots typically include Outflows from each object; the table below shows the main channel outflow slot for each object
If a Bifurcation or Pipe Junction has more than one outflow link, an error is issued.
Object 1 must be upstream of Object 2. That is, if Object 2 is not found in the search, an error is issued.
For Aggregate Reaches and Agg Distribution canals, only the elements are returned, not the aggregate (but each element includes the agg name, E.g. %“AggReach:Element1”).
