BranchOrder

See also: ParentID, VariableID

Syntax


BranchOrder, or
BranchOrder(Branch:Variable)

Description

Returns the order of a branch within its immediate set of N neighboring branches (from 0..N-1). Can be used with either the current branch or the specified branch:variable reference.  This function can be useful when you need to pass information about the LEAP tree structure to an external script or DLL. The order values will change as branches are moved and reordered.

Example

If the household branch is the first branch immediately under demand then:

BranchOrder(Demand\Household:Final Energy Intensity) = 0