INAODCostMatrix.DestinationIndexByRank Property

For a given origin, retrieves the index of the populated destination for a given rank. The index is returned only if the HasRankingAttribute is true.

[Visual Basic .NET]
Public Function get_DestinationIndexByRank ( _
    ByVal originIndex As Integer, _
    ByVal rank As Integer _
) As Integer

[C#]
public int get_DestinationIndexByRank (
    int originIndex,
    int rank
);

[C++]
HRESULT get_DestinationIndexByRank(
  long originIndex,
  long rank,
  long* destinationIndex
);

[C++]
Parameters
originIndex [in]
  originIndex is a parameter of type long
rank [in]
  rank is a parameter of type long
destinationIndex [out, retval]
  destinationIndex is a parameter of type long

Product Availability

Remarks

If the matrix has a ranking attribute, then this property retrieves a destination's index by its rank from a given origin. The closest destination has a rank of 1, the second-closest destination has a rank of 2, and so on. The largest rank equals the PopulatedDestinationCount for that origin. If two or more destinations have the same rank, then an arbitrary destination is returned.

See Also