71. GetObjectDebt

This function evaluates to the sum of the debts to all accounting exchanges which may be paid by supplies on the given object. If there are no exchange paybacks on the given object, the debt is zero.

Description

The total debt which can be paid by this object.

Type

NUMERIC

Arguments

Type

Meaning

1

OBJECT

the object who's debt to calculate

2

DATETIME

the timestep at which to calculate the debt

Evaluation

The function loops over all supplies, on all accounts, on the given object. If a supply is an exchange payback source, the value of its debt slot at the given timestep (if known) is added to the cumulative debt of the object.

Mathematical
Expression

GetObjectDebt.jpg

Comments

If the debt slot of a payback supply at the given timestep is not known, its debt is assumed to be zero. If there are no payback supplies on the given object, the total debt is zero.

Syntax Example:

GetObjectDebt(%"Heron Reservoir", @"t")

Return Example:

1.823 "m3"