UtilityTraceFunction

Functions allow the computation of values during a network trace. Functions are evaluated at each applicable network element. The meaning of applicable varies depending on the Tracer. For an upstream trace, the functions are evaluated for each upstream element. For a downstream trace, the functions are evaluated for each element in the subnetwork. etc.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(functionType: UtilityTraceFunctionType, networkAttribute: UtilityNetworkAttribute, condition: UtilityTraceCondition? = null, functionName: String = "")

Creates a function object to compute a value from a network attribute.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

An UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.

Link copied to clipboard

A user-defined name for this trace function. Use this name to define a label for the corresponding function result in the trace output. The name can describe the function type applied to a network attribute and any condition that constrains the calculation.

Link copied to clipboard

The calculation to perform.

Link copied to clipboard