This document is archived and information here might be outdated.  Recommended version.


NACompactStreetDirectionsAgent CoClass (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (NetworkAnalyst)  

NACompactStreetDirectionsAgent CoClass

Generates compact driving directions for network analysis results.

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
INAAgent Provides access to properties/methods common to all network analysis agents.
INACompactStreetDirectionsAgent Provides access to the compact directions agent.
INACompactStreetDirectionsAgent2 Provides access to the INACompactStreetDirectionsAgent2 Interface.
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.

Remarks

The NACompactStreetDirectionsAgent object generates driving directions on a route or multiple routes.  It generates directions that contain less information and compressed geometries representing the traversed streets.  Due to their smaller size, these directions are better suited for passing across low bandwidth connections in server applications.  To return these directions using NAServer, rather than using this object directly, set the property INAServerRouteParams2::ReturnCompactDirections or INAServerClosestFacilityParams2::ReturnCompactDirections to true.

You get the NACompactStreetDirectionsAgent from the NAContext's list of agents using the name "CompactStreetDirectionsAgent".  For example:

Set pStreetAgent=NAContext.Agents.ItemByName("CompactStreetDirectionsAgent")