AGSUtilityTraceFunction Class Reference

Description

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.

Since

100.7

Inheritance diagram for AGSUtilityTraceFunction:

Instance Methods
(instancetype)	- initWithFunctionType:networkAttribute:
(instancetype)	- initWithFunctionType:networkAttribute:condition:

Class Methods
(instancetype)	+ utilityTraceFunctionWithFunctionType:networkAttribute:
(instancetype)	+ utilityTraceFunctionWithFunctionType:networkAttribute:condition:

Properties
AGSUtilityTraceCondition *	condition
AGSUtilityTraceFunctionType	functionType
AGSUtilityNetworkAttribute *	networkAttribute

Method Documentation

initWithFunctionType:networkAttribute:

- (instancetype) initWithFunctionType:		(AGSUtilityTraceFunctionType)	functionType
networkAttribute:		(AGSUtilityNetworkAttribute *)	networkAttribute

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

Parameters

functionType	The calculation to perform.
networkAttribute	The AGSUtilityNetworkAttribute object to use with the calculation.

Since

100.7

initWithFunctionType:networkAttribute:condition:

- (instancetype) initWithFunctionType:		(AGSUtilityTraceFunctionType)	functionType
networkAttribute:		(AGSUtilityNetworkAttribute *)	networkAttribute
condition:		(AGSUtilityTraceCondition *)	condition

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

Parameters

functionType	The calculation to perform.
networkAttribute	The AGSUtilityNetworkAttribute object to use with the calculation.
condition	An AGSUtilityTraceCondition object to use to restrict the functional calculation to features that satisfy the condition.

Since

100.9

utilityTraceFunctionWithFunctionType:networkAttribute:

+ (instancetype) utilityTraceFunctionWithFunctionType:		(AGSUtilityTraceFunctionType)	functionType
networkAttribute:		(AGSUtilityNetworkAttribute *)	networkAttribute

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

Parameters

functionType	The calculation to perform.
networkAttribute	The AGSUtilityNetworkAttribute object to use with the calculation.

Returns

A new AGSUtilityTraceFunction object.

Since

100.7

utilityTraceFunctionWithFunctionType:networkAttribute:condition:

+ (instancetype) utilityTraceFunctionWithFunctionType:		(AGSUtilityTraceFunctionType)	functionType
networkAttribute:		(AGSUtilityNetworkAttribute *)	networkAttribute
condition:		(AGSUtilityTraceCondition *)	condition

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

Parameters

functionType	The calculation to perform.
networkAttribute	The AGSUtilityNetworkAttribute object to use with the calculation.
condition	An AGSUtilityTraceCondition object to use to restrict the functional calculation to features that satisfy the condition.

Returns

A new AGSUtilityTraceFunction object.

Since

100.9

Property Documentation

condition

- (AGSUtilityTraceCondition*) condition

readwritenonatomicstrong

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

Since

100.9

functionType

- (AGSUtilityTraceFunctionType) functionType

readnonatomicassign

The calculation to perform.

Since

100.7

networkAttribute

- (AGSUtilityNetworkAttribute*) networkAttribute

readnonatomicstrong

The AGSUtilityNetworkAttribute object to use with the calculation.

Since

100.7