com.esri.arcgis.networkanalyst
Interface INAODCostMatrix

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

INAODCostMatrixProxy, NAODCostMatrixResult

public interface INAODCostMatrix
extends java.io.Serializable

COM Interface 'INAODCostMatrix'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Provides access to the OD cost matrix object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID640f6408_3868_4990_8699_cde0042f5d17
static int	xxDummy Deprecated. Internal use only

Method Summary

int	findDestinationIndex(INALocation location, int curbApproach) Finds the destination corresponding to the given network location.
int	findOriginIndex(INALocation location, int curbApproach) Finds the origin corresponding to the given network location.
IStringArray	getCostAttributeNames() The names of the network cost attributes.
double	getDefaultValue(int attributeIndex) The value returned for un-populated matrix enteries.
int	getDestinationCount() The number of destination locations.
int	getDestinationIndexByRank(int originIndex, int rank) For a given origin, retrieves the index of the populated destination for a given rank.
IName	getNetworkDatasetName() The name of the network dataset.
int	getOriginCount() The number of origin locations.
int	getPopulatedDestinationCount(int originIndex) For a given origin, retrieves the number of destinations with populated matrix values.
int	getRankingAttributeIndex() The index of the cost attribute used to rank the populated destinations for each origin.
double	getValue(int originIndex, int destinationIndex, int attributeIndex) Retrieves the cost value for a given origin and destination.
boolean	isAreOriginsIdenticalToDestinations() Indicates if the origin set is identical to the destination set, i.e.
boolean	isHasRankingAttribute() Indicates if the matrix has an attribute for ranking values.
boolean	isPopulated(int originIndex, int destinationIndex) Indicates if the matrix entry for given origin, destination index is populated.
boolean	isSymmetric() Indicates if the matrix has symmetric values.
void	queryPopulatedDestinationIndices(int originIndex, ILongArray[] destinationIndices) For a given origin, retrieves the indices of populated destinations.
void	queryRankedDestinationIndices(int originIndex, ILongArray[] destinationIndices) For a given origin, retrieves the indices of the populated destinations in increasing rank.
void	queryValues(int originIndex, int destinationIndex, IDoubleArray[] values) Retrieves the cost values of all cost attributes for the given origin and destination.

Field Detail

IID640f6408_3868_4990_8699_cde0042f5d17

static final int IID640f6408_3868_4990_8699_cde0042f5d17

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getNetworkDatasetName

IName getNetworkDatasetName()
                            throws java.io.IOException,
                                   AutomationException

The name of the network dataset.

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCostAttributeNames

IStringArray getCostAttributeNames()
                                   throws java.io.IOException,
                                          AutomationException

The names of the network cost attributes.

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginCount

int getOriginCount()
                   throws java.io.IOException,
                          AutomationException

The number of origin locations.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationCount

int getDestinationCount()
                        throws java.io.IOException,
                               AutomationException

The number of destination locations.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreOriginsIdenticalToDestinations

boolean isAreOriginsIdenticalToDestinations()
                                            throws java.io.IOException,
                                                   AutomationException

Indicates if the origin set is identical to the destination set, i.e. that every origin network location also exists as a destination network location.

Returns:

The areIdentical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymmetric

boolean isSymmetric()
                    throws java.io.IOException,
                           AutomationException

Indicates if the matrix has symmetric values.

Returns:

The isSymmetric

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findOriginIndex

int findOriginIndex(INALocation location,
                    int curbApproach)
                    throws java.io.IOException,
                           AutomationException

Finds the origin corresponding to the given network location.

Parameters:

location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)

curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findDestinationIndex

int findDestinationIndex(INALocation location,
                         int curbApproach)
                         throws java.io.IOException,
                                AutomationException

Finds the destination corresponding to the given network location.

Parameters:

location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)

curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

double getDefaultValue(int attributeIndex)
                       throws java.io.IOException,
                              AutomationException

The value returned for un-populated matrix enteries.

Parameters:

attributeIndex - The attributeIndex (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPopulatedDestinationCount

int getPopulatedDestinationCount(int originIndex)
                                 throws java.io.IOException,
                                        AutomationException

For a given origin, retrieves the number of destinations with populated matrix values.

Parameters:

originIndex - The originIndex (in)

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPopulatedDestinationIndices

void queryPopulatedDestinationIndices(int originIndex,
                                      ILongArray[] destinationIndices)
                                      throws java.io.IOException,
                                             AutomationException

For a given origin, retrieves the indices of populated destinations.

Parameters:

originIndex - The originIndex (in)

destinationIndices - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPopulated

boolean isPopulated(int originIndex,
                    int destinationIndex)
                    throws java.io.IOException,
                           AutomationException

Indicates if the matrix entry for given origin, destination index is populated.

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

Returns:

The isPopulated

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasRankingAttribute

boolean isHasRankingAttribute()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the matrix has an attribute for ranking values.

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRankingAttributeIndex

int getRankingAttributeIndex()
                             throws java.io.IOException,
                                    AutomationException

The index of the cost attribute used to rank the populated destinations for each origin.

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestinationIndexByRank

int getDestinationIndexByRank(int originIndex,
                              int rank)
                              throws java.io.IOException,
                                     AutomationException

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.

Parameters:

originIndex - The originIndex (in)

rank - The rank (in)

Returns:

The destinationIndex

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryRankedDestinationIndices

void queryRankedDestinationIndices(int originIndex,
                                   ILongArray[] destinationIndices)
                                   throws java.io.IOException,
                                          AutomationException

For a given origin, retrieves the indices of the populated destinations in increasing rank.

Parameters:

originIndex - The originIndex (in)

destinationIndices - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

double getValue(int originIndex,
                int destinationIndex,
                int attributeIndex)
                throws java.io.IOException,
                       AutomationException

Retrieves the cost value for a given origin and destination. The attribute index is with respect to the array of cost attribute names returned by CostAttributeNames.

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

attributeIndex - The attributeIndex (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryValues

void queryValues(int originIndex,
                 int destinationIndex,
                 IDoubleArray[] values)
                 throws java.io.IOException,
                        AutomationException

Retrieves the cost values of all cost attributes for the given origin and destination.

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

values - A reference to a com.esri.arcgis.system.IDoubleArray (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.