ArcObjects Library Reference  (NetworkAnalyst)    

NAServerPropertySets CoClass

A container for an array of PropertySet objects representing network locations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Network Analyst Extension.

Extended Error Information

Use the ISupportErrorInfo method InterfaceSupportsErrorInfo to determine if the object supports extended error information. If the object supports extended error info, VC++ developers should use the OLE/COM IErrorInfo interface to access the ErrorInfo object. Visual Basic developers should use the global error object Err to retrieve this extended error information.

Interfaces

Interfaces Description
INAServerLocations Provides access to objects that can be used to load network locations in NAServer.
INAServerPropertySets Provides access to an array of PropertySet objects representing network locations.
IPersist Defines the single method GetClassID, which is designed to supply the CLSID of an object that can be stored persistently in the system. IPersist is the base interface for three other interfaces: IPersistStorage, IPersistStream, and IPersistFile.
IPersistStream (esriSystem)
ISupportErrorInfo Indicates whether a specific interface can return Automation error objects.
IXMLSerialize (esriSystem) Provides access to members that XML serialize and deserialize an object to/from XML.
IXMLVersionSupport (esriSystem) Provides access to members that help in serializing an object to different namespaces (versions).

Remarks

The NAServerPropertySets object holds an array of PropertySet objects.  Each PropertySet represents a network location.

The NAServerPropertySets object can be passed into 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 are internally converted into a RecordSet and used to load the network locations.  The fields on the RecordSet are 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 choose to use additional properties 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 perform a spatial search to determine the network location.

Any other properties can be added to the PropertySet and used when loading network locations.  INAServerSolverParams.NAClassCandidateFieldMaps determines which properties map to NAClass fields.