com.esri.arcgis.networkanalyst
Interface INAServerPropertySets

All Superinterfaces:
INAServerLocations, Serializable
All Known Implementing Classes:
NAServerPropertySets

public interface INAServerPropertySets
extends INAServerLocations, Serializable

Provides access to an array of PropertySet objects representing network locations.

Remarks

The INAServerPropertySets interface provides access to an array of PropertySet objects. Each PropertySet represents a network location.

The NAServerPropertySets object that implements this interface can be passed in to any of the properties of the NAServerSolverParams objects that expect an INAServerLocations interface pointer. For example, Stops, Barriers, Facilities, or Incidents.

The array of property sets will internally be converted into a RecordSet and used to load the network locations. The fields on the RecordSet will be determined based on the property names/types contained within the first PropertySet of the array.

At a minimum, each PropertySet should include a shape representing the location of the network location to use for locating. This shape can either be specified by the property "Shape" with a value of a Point geometry object or it can be specified by the properties "X" and "Y" with a value of type double and optionally a property "SpatialReference" with a value of a spatial reference object. If the spatial reference is not specified, the X and Y are assumed to be in the same spatial reference as the underlying network dataset.

You can also add additional properties that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (long), "SourceOID" (long), "PosAlong" (double), and "SideOfEdge" (long) the values in these properties will specify the network location rather than performing a spatial search to determine the network location.

Any other properties can be added to the PropertySet and may be used when loading network locations. What properties map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps.

Product Availability

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


Method Summary
 IPropertySetArray getPropertySets()
          Array of property sets.
 void setPropertySetsByRef(IPropertySetArray ppValue)
          Array of property sets.
 

Method Detail

getPropertySets

IPropertySetArray getPropertySets()
                                  throws IOException,
                                         AutomationException
Array of property sets.

Remarks

The PropertySets property provides access to the IPropertySetArray interface holding an array PropertySet objects. Each PropertySet represents a network location.

The array of property sets will internally be converted into a RecordSet and used to load the network locations. The fields on the RecordSet will be determined based on the property names/types contained within the first PropertySet of the array.

At a minimum, each PropertySet should include a shape representing the location of the network location to use for locating. This shape can either be specified by the property "Shape" with a value of a Point geometry object or it can be specified by the properties "X" and "Y" with a value of type double and optionally a property "SpatialReference" with a value of a spatial reference object. If the spatial reference is not specified, the X and Y are assumed to be in the same spatial reference as the underlying network dataset.

You can also add additional properties that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (long), "SourceOID" (long), "PosAlong" (double), and "SideOfEdge" (long) the values in these properties will specify the network location rather than performing a spatial search to determine the network location.

Any other properties can be added to the PropertySet and may be used when loading network locations. What properties map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps.

Product Availability

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

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

setPropertySetsByRef

void setPropertySetsByRef(IPropertySetArray ppValue)
                          throws IOException,
                                 AutomationException
Array of property sets.

Remarks

The PropertySets property provides access to the IPropertySetArray interface holding an array PropertySet objects. Each PropertySet represents a network location.

The array of property sets will internally be converted into a RecordSet and used to load the network locations. The fields on the RecordSet will be determined based on the property names/types contained within the first PropertySet of the array.

At a minimum, each PropertySet should include a shape representing the location of the network location to use for locating. This shape can either be specified by the property "Shape" with a value of a Point geometry object or it can be specified by the properties "X" and "Y" with a value of type double and optionally a property "SpatialReference" with a value of a spatial reference object. If the spatial reference is not specified, the X and Y are assumed to be in the same spatial reference as the underlying network dataset.

You can also add additional properties that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (long), "SourceOID" (long), "PosAlong" (double), and "SideOfEdge" (long) the values in these properties will specify the network location rather than performing a spatial search to determine the network location.

Any other properties can be added to the PropertySet and may be used when loading network locations. What properties map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps.

Product Availability

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

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