Click or drag to resize

Break Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
Represents a Break on a route.
Inheritance Hierarchy

Namespace:  Telogis.GeoBase
Assembly:  geobase.net (in geobase.net.dll) Version: 4.99.0.0
Syntax
public class Break : RouteStop

The Break type exposes the following members.

Constructors
  NameDescription
Public methodBreak(LatLon)
Creates a Break at the given location.
Public methodCode exampleBreak(Double, Double)
Creates a Break at the given latitude and longitude.
Top
Properties
  NameDescription
Public propertyApproaches
List of AccessPaths that can be used to approach this route stop.
(Inherited from RouteStop.)
Public propertyAverageTime
Average time spent at this stop.
(Inherited from RouteStop.)
Public propertyDepartures
List of AccessPaths that can be used to depart from this route stop.
(Inherited from RouteStop.)
Public propertyDescription
Description of the stop. See remarks.
(Inherited from RouteStop.)
Public propertyDrawHandle
Set to true to display a handle on the RouteStop icon. The handle allows the user to rotate the heading of the stop.
(Inherited from RouteStop.)
Public propertyEnd
If true this stop is the end point for the route. See Start for more details.
(Inherited from RouteStop.)
Public propertyHeading
The heading for this route stop. This value will be used to choose which street this RouteStop belongs on - GeoBase will try to route to a street that is aligned with this heading. For example, this can be used to avoid accidentally routing from a cross street. If this value is float.NaN, then this behavior will be ignored.
(Inherited from RouteStop.)
Public propertyIconNumber
Sets the type of icon displayed for the stop.
(Inherited from RouteStop.)
Public propertyIdlePenalty
Used to specify a penalty for the idle time. When set, this value is used as the penalty for a TooEarly violation during Route Optimization i.e., the waiting time at the stop.
(Inherited from RouteStop.)
Public propertyIgnitionOn Obsolete.
Whether the unit's ignition was on when it was at this stop in the route history. Used when calculating a route highlight.
(Inherited from RouteStop.)
Public propertyLocation
Location of the stop point, as a LatLon.
(Inherited from RouteStop.)
Public propertyMapMouseEventsHandler
Gets the MapMouseEventsHandler for this RouteStop.
(Inherited from RouteStop.)
Public propertyCode exampleMinimumTime
Minimum time to be spent at the Break. During route optimization, if the minimum time exceeds the average time, it will be used as the time spent at the stop instead of the average time.
Public propertyPenalty
Represents a penalty incurred for missing the alloted window. The penalty must be greater than or equal to zero. A value of -1 indicates that the penalty has not been set.
(Inherited from RouteStop.)
Public propertyCode exampleRenderBrush
A Brush used to color this stop.
(Inherited from RouteStop.)
Public propertyRenderSize
Gets the render Size used for this stop.
(Inherited from RouteStop.)
Public propertyRequiredRendermodes
Gets the RenderMode required by this RouteStop.
(Inherited from RouteStop.)
Public propertyRoadIntersection
Point where you enter or exit the street network to get to this stop.
(Inherited from RouteStop.)
Public propertySpeed
Gets or sets the speed when at or passing the RouteStop.
(Inherited from RouteStop.)
Public propertyStart
If true this stop is the start point for the route.
(Inherited from RouteStop.)
Public propertyCode exampleStartTimeIsFixed
For Breaks with no specific location, this property makes the time window begin and end at the WindowStart time. The Break will begin at the WindowStart time unless the penalties set for the optimization make it too costly to do so. The WindowStart property must be set to use the StartTimeIsFixed property. This property has no effect if the Break has a location.
Public propertyStopNumber
The Number of this stop. Set by the routing engine.
(Inherited from RouteStop.)
Public propertyTag
For external use - set to whatever you like.
(Inherited from RouteStop.)
Public propertyCode exampleTimeIncludesExtraTravel
If true, extra time taken for travel to the location of the Break is taken out of the time for the Break, up to the minimum time available. This is only used for breaks which have a specific location.
Public propertyTimeSincePreviousStop
Time in seconds since the unit was at the previous stop in the route history. Used when calculating a route highlight. If this value is too small, the routing engine will fail to query an area that is sufficiently large in size.
(Inherited from RouteStop.)
Public propertyWindowEnd
Latest delivery time.
(Inherited from RouteStop.)
Public propertyWindowStart
Earliest delivery time.
(Inherited from RouteStop.)
Top
Methods
  NameDescription
Public methodClone
Used to create an identical instance (clone) of a RouteStop.
(Inherited from RouteStop.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEqualsIgnoreStopNumber
Indicates whether the specified RouteStop is equal to the current RouteStop, excluding its StopNumber property.
(Inherited from RouteStop.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHitTest(Point, IMap) (Inherited from RouteStop.)
Public methodHitTest(Int32, Int32, IMap) (Inherited from RouteStop.)
Public methodRender
Render this RouteStop.
(Inherited from RouteStop.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldDontLoadBefore Obsolete.
Array of stops whose load must not be loaded before this stop. Not yet implemented.
(Inherited from RouteStop.)
Public fieldIncompatibleLoads Obsolete.
Array of stops whose loads should not be carried with the load for this stop. Dynamite shouldn't be with matches. Not yet implemented.
(Inherited from RouteStop.)
Public fieldLoad Obsolete.
Quantity of goods to be delivered (or collected). Not yet implemented.
(Inherited from RouteStop.)
Public fieldSkillsRequired Obsolete.
Specific 'skills' that this stop requires. Must match a bit in the vehicle skills map. Not yet implemented.
(Inherited from RouteStop.)
Top
Remarks
See Also