Collection of NetworkAnalyst enumerations. More...
Header: | #include <NetworkAnalystTypes.h> |
Types
enum class | AttributeUnit { Unknown, Inches, Feet, Yards, Miles, …, Days } |
enum class | BarrierType { Restriction, CostAdjustment } |
enum class | CurbApproach { EitherSide, LeftSide, RightSide, NoUturn, Unknown } |
enum class | DirectionManeuverType { Unknown, Stop, Straight, BearLeft, BearRight, …, DoorPassage } |
enum class | DirectionMessageType { StreetName, AlternativeName, Branch, Toward, CrossStreet, Exit } |
enum class | DirectionsStyle { Desktop, Navigation, Campus } |
enum class | LocationStatus { NotLocated, OnClosest, OnClosestNotRestricted, NotReached } |
enum class | NetworkDirectionsSupport { Unknown, Unsupported, Supported } |
enum class | RouteShapeType { None, StraightLine, TrueShapeWithMeasures } |
enum class | ServiceAreaOverlapGeometry { Overlap, Dissolve, Split } |
enum class | ServiceAreaPolygonCutoffGeometry { Rings, Disks } |
enum class | ServiceAreaPolygonDetail { Generalized, Standard, High } |
enum class | StartTimeUsage { DepartureTime, ArrivalTime } |
enum class | StopType { Stop, Waypoint, RestBreak } |
enum class | TravelDirection { FromFacility, ToFacility } |
enum class | UTurnPolicy { NotAllowed, AllowedAtDeadEnds, AllowedAtIntersections, AllowedAtDeadEndsAndIntersections } |
Detailed Description
Type Documentation
[since Esri::ArcGISRuntime 100.0]
enum class AttributeUnit
Types of unit for network attributes.
The AttributeUnit can be one of:
Constant | Value | Description |
---|---|---|
AttributeUnit::Unknown | 0 | An unknown unit. |
AttributeUnit::Inches | 1 | An inches attribute unit. |
AttributeUnit::Feet | 2 | A feet attribute unit. |
AttributeUnit::Yards | 3 | A yards attribute unit. |
AttributeUnit::Miles | 4 | A miles attribute unit. |
AttributeUnit::Millimeters | 5 | A millimeters attribute unit. |
AttributeUnit::Centimeters | 6 | A centimeters attribute unit. |
AttributeUnit::Decimeters | 7 | A decimeters attribute unit. |
AttributeUnit::Meters | 8 | A meters attribute unit. |
AttributeUnit::Kilometers | 9 | A kilometers attribute unit. |
AttributeUnit::NauticalMiles | 10 | A nautical miles attribute unit. |
AttributeUnit::DecimalDegrees | 11 | A decimal degrees attribute unit. |
AttributeUnit::Seconds | 12 | A seconds attribute unit. |
AttributeUnit::Minutes | 13 | A minutes attribute unit. |
AttributeUnit::Hours | 14 | An hours attribute unit. |
AttributeUnit::Days | 15 | A days attribute unit. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0]
enum class BarrierType
Enumerates the type of barrier for a route.
The BarrierType can be one of:
Constant | Value | Description |
---|---|---|
BarrierType::Restriction | 0 | A restriction attribute barrier type. |
BarrierType::CostAdjustment | 1 | A cost adjustment barrier type. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0]
enum class CurbApproach
Enumerates the side of street for arrivals or departures of a route.
The CurbApproach can be one of:
Constant | Value | Description |
---|---|---|
CurbApproach::EitherSide | 0 | An either side curb approach. |
CurbApproach::LeftSide | 1 | A left side curb approach. |
CurbApproach::RightSide | 2 | A right side curb approach. |
CurbApproach::NoUturn | 3 | A no U-turn curb approach. |
CurbApproach::Unknown | 4 | An unknown curb approach, used when the approach is not determined. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0]
enum class DirectionManeuverType
Enumerates the types of direction maneuvers on a route.
The DirectionManeuverType can be one of:
Constant | Value | Description |
---|---|---|
DirectionManeuverType::Unknown | 0 | An unknown maneuver. |
DirectionManeuverType::Stop | 1 | A stop maneuver. |
DirectionManeuverType::Straight | 2 | A continue straight maneuver. |
DirectionManeuverType::BearLeft | 3 | A bear left maneuver. |
DirectionManeuverType::BearRight | 4 | A bear right maneuver. |
DirectionManeuverType::TurnLeft | 5 | A left turn. |
DirectionManeuverType::TurnRight | 6 | A right turn. |
DirectionManeuverType::SharpLeft | 7 | A sharp left turn. |
DirectionManeuverType::SharpRight | 8 | A sharp right turn. |
DirectionManeuverType::UTurn | 9 | A U-turn. |
DirectionManeuverType::Ferry | 10 | A maneuver connecting with a ferry. |
DirectionManeuverType::Roundabout | 11 | A maneuver via roundabout. |
DirectionManeuverType::HighwayMerge | 12 | A merge of several highways. |
DirectionManeuverType::HighwayExit | 13 | An exit from a highway. |
DirectionManeuverType::HighwayChange | 14 | A change of highway. |
DirectionManeuverType::ForkCenter | 15 | A straight at fork. |
DirectionManeuverType::ForkLeft | 16 | A left at fork. |
DirectionManeuverType::ForkRight | 17 | A right at fork. |
DirectionManeuverType::Depart | 18 | A departure. |
DirectionManeuverType::TripItem | 19 | Connected with trip planning maneuver. |
DirectionManeuverType::EndOfFerry | 20 | An end of ferry transfer. |
DirectionManeuverType::RampRight | 21 | A maneuver to the right on a ramp. |
DirectionManeuverType::RampLeft | 22 | A maneuver to the left on a ramp. |
DirectionManeuverType::TurnLeftRight | 23 | A complex maneuver; turn left, then right. |
DirectionManeuverType::TurnRightLeft | 24 | A complex maneuver; turn right, then left. |
DirectionManeuverType::TurnRightRight | 25 | A complex maneuver; turn right, then right. |
DirectionManeuverType::TurnLeftLeft | 26 | A complex maneuver; turn left, then left. |
DirectionManeuverType::PedestrianRamp | 27 | A maneuver via pedestrian ramp. |
DirectionManeuverType::Elevator | 28 | A maneuver via elevator. |
DirectionManeuverType::Escalator | 29 | A maneuver via escalator. |
DirectionManeuverType::Stairs | 30 | A maneuver via stairs. |
DirectionManeuverType::DoorPassage | 31 | Passing through a door. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0]
enum class DirectionMessageType
Type of direction string.
The DirectionMessageType can be one of:
Constant | Value | Description |
---|---|---|
DirectionMessageType::StreetName | 9 | A street name. |
DirectionMessageType::AlternativeName | 10 | An alternative street name. |
DirectionMessageType::Branch | 11 | A signpost branch. |
DirectionMessageType::Toward | 12 | A signpost toward. |
DirectionMessageType::CrossStreet | 13 | An intersected street name. |
DirectionMessageType::Exit | 14 | A signpost exit. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0]
enum class DirectionsStyle
The network directions output type.
The DirectionsStyle can be one of:
Constant | Value | Description |
---|---|---|
DirectionsStyle::Desktop | 0 | The driving directions generated by this style are good for desktop/printing apps. |
DirectionsStyle::Navigation | 1 | The driving directions generated by this style are good for navigation applications. |
DirectionsStyle::Campus | 2 | The driving directions generated by this style are good for campus routing. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0]
enum class LocationStatus
Status regarding the network location associated with a stop.
The LocationStatus can be one of:
Constant | Value | Description |
---|---|---|
LocationStatus::NotLocated | 0 | A not located status. |
LocationStatus::OnClosest | 1 | Located on closest network element. |
LocationStatus::OnClosestNotRestricted | 2 | Located on closest network element which is not restricted. |
LocationStatus::NotReached | 3 | The network location can't be arrived at by the solver. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.7]
enum class NetworkDirectionsSupport
An enumeration of the various types of RouteTaskInfo::directionsSupport values.
The NetworkDirectionsSupport can be one of:
Constant | Value | Description |
---|---|---|
NetworkDirectionsSupport::Unknown | -1 | Directions support is unknown. |
NetworkDirectionsSupport::Unsupported | 0 | Directions are unsupported. |
NetworkDirectionsSupport::Supported | 1 | Directions are supported. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.7.
[since Esri::ArcGISRuntime 100.0]
enum class RouteShapeType
Enumerates the output shape type for a route.
The RouteShapeType can be one of:
Constant | Value | Description |
---|---|---|
RouteShapeType::None | 0 | No shape type. |
RouteShapeType::StraightLine | 1 | A straight line shape type. |
RouteShapeType::TrueShapeWithMeasures | 2 | A true shape type with measures. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.1]
enum class ServiceAreaOverlapGeometry
Service area overlap geometry.
Specifies the behavior of service-area output from multiple facilities in relation to one another.
The ServiceAreaOverlapGeometry can be one of:
Constant | Value | Description |
---|---|---|
ServiceAreaOverlapGeometry::Overlap | 0 | Creates individual polygons or sets of lines for each facility. The polygons or lines can overlap each other. |
ServiceAreaOverlapGeometry::Dissolve | 1 | Joins the polygons of multiple facilities that have the same cutoff value into a single polygon. Lines will not overlap each other. |
ServiceAreaOverlapGeometry::Split | 2 | Area is assigned to the closest facility so polygons or lines do not overlap each other. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.1]
enum class ServiceAreaPolygonCutoffGeometry
Service area polygon cutoff geometry.
Specifies the behavior of service area output for a single facility when multiple cutoff values are specified. This parameter does not apply to line output.
The ServiceAreaPolygonCutoffGeometry can be one of:
Constant | Value | Description |
---|---|---|
ServiceAreaPolygonCutoffGeometry::Rings | 0 | Each polygon includes only the area between consecutive cutoff values. It does not include the area between the facility and any smaller cutoffs. For instance, If you create 5- and 10-minute service areas, then the 5-minute service area polygon will include the area reachable in 0-5 minutes, and the 10-minute service area polygon will include the area reachable between 5 and 10 minutes. |
ServiceAreaPolygonCutoffGeometry::Disks | 1 | Each polygon includes the area reachable from the facility up to the cutoff value, including the area reachable within smaller cutoff values. For instance, If you create 5- and 10-minute service areas, then the 10-minute service area polygon will include the area under the 5-minute service area polygon. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.1]
enum class ServiceAreaPolygonDetail
Service area polygon detail.
Specifies the level of detail of the output polygons. If your analysis covers an urban area with a grid-like street network, the difference between generalized and standard polygons will be minimal. However, for mountain and rural roads, the standard and detailed polygons may present significantly more accurate results than generalized polygons.
The ServiceAreaPolygonDetail can be one of:
Constant | Value | Description |
---|---|---|
ServiceAreaPolygonDetail::Generalized | 0 | Creates generalized polygons using the hierarchy present in the network data source in order to produce results quickly. |
ServiceAreaPolygonDetail::Standard | 1 | Creates polygons with a standard level of detail. This is the default. |
ServiceAreaPolygonDetail::High | 2 | Creates polygons with a higher level of detail for applications in which very precise results are important. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.1]
enum class StartTimeUsage
Enumerates the start time usage types.
The StartTimeUsage can be one of:
Constant | Value | Description |
---|---|---|
StartTimeUsage::DepartureTime | 0 | Use as departure time. |
StartTimeUsage::ArrivalTime | 1 | Use as arrival time. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.1]
enum class StopType
A stop's type. Specifies the type of a route stop.
The StopType can be one of:
Constant | Value | Description |
---|---|---|
StopType::Stop | 0 | Stop. A location where a vehicle would arrive and/or depart. |
StopType::Waypoint | 1 | Waypoint. A location between stops that a route must pass through. |
StopType::RestBreak | 2 | Rest break. A location where a route pauses e.g. for a required lunch break. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.1]
enum class TravelDirection
A travel direction type. Options for traveling to or from the facility.
The default is defined in the network layer.
The TravelDirection can be one of:
Constant | Value | Description |
---|---|---|
TravelDirection::FromFacility | 0 | Travel from facility. |
TravelDirection::ToFacility | 1 | Travel to facility. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.0]
enum class UTurnPolicy
Enumerates the type of backtracking allowed via U-turns in a network.
The UTurnPolicy can be one of:
Constant | Value | Description |
---|---|---|
UTurnPolicy::NotAllowed | 0 | No U-turns allowed. |
UTurnPolicy::AllowedAtDeadEnds | 1 | U-turns only allowed at dead ends. |
UTurnPolicy::AllowedAtIntersections | 2 | U-turns only allowed at intersections. |
UTurnPolicy::AllowedAtDeadEndsAndIntersections | 3 | U-turns allowed at dead ends and intersections. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.