' Copyright 2011 ESRI
' 
' All rights reserved under the copyright laws of the United States
' and applicable international laws, treaties, and conventions.
' 
' You may freely redistribute and use this sample code, with or
' without modification, provided you include the original copyright
' notice and use restrictions.
' 
' See the use restrictions.
' 




Imports Microsoft.VisualBasic
Imports System
Imports System.Data
Imports System.Collections.Specialized
Imports ESRI.ArcGIS.ADF.Web.Geometry


Namespace ESRI.ArcGIS.Server.Web.NetworkAnalyst
  ''' <summary>
  ''' Result from a Network Analyst Solve operation on Route layers.
  ''' </summary>
  Public Class NetworkAnalystRouteResult
    ''' <summary>
    ''' Constructor.
    ''' </summary>
    Public Sub New()
    End Sub

#Region "Member Vars"
    Private m_summary As StringDictionary
    Private m_extent As Envelope
    Private m_directions As DataTable
    Private m_directionsExtents As Envelope()
    Private m_routeID As Integer
#End Region

#Region "Properties"

    ''' <summary>
    ''' Summary information on this route.
    ''' </summary>
    Public Property Summary() As StringDictionary
      Get
        Return m_summary
      End Get
      Set(ByVal value As StringDictionary)
        m_summary = Value
      End Set
    End Property

    ''' <summary>
    ''' The extent of this route.
    ''' </summary>
    Public Property RouteExtent() As Envelope
      Get
        Return m_extent
      End Get
      Set(ByVal value As Envelope)
        m_extent = Value
      End Set
    End Property

    ''' <summary>
    ''' The object id of the route feature
    ''' </summary>
    Public Property RouteID() As Integer
      Get
        Return m_routeID
      End Get
      Set(ByVal value As Integer)
        m_routeID = Value
      End Set
    End Property

    ''' <summary>
    ''' The step-by-step directions for this route.
    ''' </summary>
    Public Property Directions() As DataTable
      Get
        Return m_directions
      End Get
      Set(ByVal value As DataTable)
        m_directions = Value
      End Set
    End Property

    ''' <summary>
    ''' Envelope for each step in the directions.  Reference by row index.
    ''' </summary>
    Public Property StepExtents() As Envelope()
      Get
        Return m_directionsExtents
      End Get
      Set(ByVal value As Envelope())
        m_directionsExtents = Value
      End Set
    End Property

#End Region

  End Class
End Namespace