com.esri.arcgis.networkanalyst
Interface INAClassCandidateFieldMap

All Superinterfaces:
Serializable
All Known Implementing Classes:
NAClassCandidateFieldMap

public interface INAClassCandidateFieldMap
extends Serializable

Provides access to the candidate field maps of an NAClass.

Remarks

INAClassCandidateFieldMap is an interface on the NAClassCandidateFieldMap object used to specify the default values and candidate field names for an NAClass.

An NAClassCandidateFieldMap object holds an array of NACandidateFieldMap objects.

Within INAServer::Solve the information provided by INAClassCandidateFieldMap::CandidateFieldMaps is applied to an NAClassFieldMap object prior to loading network locations to specify the values of the network locations based on the default values and candidate fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 INACandidateFieldMap[] getCandidateFieldMaps()
          Candidate Field Maps.
 String getNAClassName()
          Name of the NAClass.
 void setCandidateFieldMaps(INACandidateFieldMap[] ppCandidateFieldMaps)
          Candidate Field Maps.
 void setNAClassName(String name)
          Name of the NAClass.
 

Method Detail

getNAClassName

String getNAClassName()
                      throws IOException,
                             AutomationException
Name of the NAClass.

Remarks

NAClassName refers to the name of the NAClass that this NAClassCandidateFieldMap is referencing. The array of CandidateFieldMaps will be applied to this NAClass.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNAClassName

void setNAClassName(String name)
                    throws IOException,
                           AutomationException
Name of the NAClass.

Remarks

NAClassName refers to the name of the NAClass that this NAClassCandidateFieldMap is referencing. The array of CandidateFieldMaps will be applied to this NAClass.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCandidateFieldMaps

INACandidateFieldMap[] getCandidateFieldMaps()
                                             throws IOException,
                                                    AutomationException
Candidate Field Maps.

Remarks

The CandidateFieldMaps property holds an array of NACandidateFieldMap objects that will be applied to the NAClass with the name specified by NAClassName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.networkanalyst.INACandidateFieldMap array
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCandidateFieldMaps

void setCandidateFieldMaps(INACandidateFieldMap[] ppCandidateFieldMaps)
                           throws IOException,
                                  AutomationException
Candidate Field Maps.

Remarks

The CandidateFieldMaps property holds an array of NACandidateFieldMap objects that will be applied to the NAClass with the name specified by NAClassName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INACandidateFieldMap array (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.