ISMFlagCreator.CreateFlagDirectionAdv Method

Creates the route flag using its geographic location, required direction and latency.

[Visual Basic .NET]
Public Function CreateFlagDirectionAdv ( _
    ByVal pPoint As SMRouterPoint, _
    ByVal dOrientation As Double, _
    ByVal dTolerance As Double, _
    ByVal dSpeed As Double, _
    ByVal dLatency As Double, _
    ByRef pdAdjustedOrientation As Double _
) As SMFlag

[C#]
public SMFlag CreateFlagDirectionAdv (
    SMRouterPoint pPoint,
    double dOrientation,
    double dTolerance,
    double dSpeed,
    double dLatency,
    ref double pdAdjustedOrientation
);

[C++]
HRESULT CreateFlagDirectionAdv(
  ISMRouterPoint* pPoint,
  double dOrientation,
  double dTolerance,
  double dSpeed,
  double dLatency,
  double* pdAdjustedOrientation,
  ISMFlag** ppFlag
);

[C++]
Parameters
pPoint [in]
  pPoint is a parameter of type ISMRouterPoint
dOrientation [in]
  dOrientation is a parameter of type double
dTolerance [in]
  dTolerance is a parameter of type double
dSpeed [in]
  dSpeed is a parameter of type double
dLatency [in]
  dLatency is a parameter of type double
pdAdjustedOrientation [out]
  pdAdjustedOrientation is a parameter of type double
ppFlag [out, retval]
  ppFlag is a parameter of type ISMFlag

Product Availability

Description

Creates the route flag using geographic location, required location, and latency.

Remarks

This method may be used if exact snapped position of flag is needed.

The dOrientation argument is associated with the input geographic location (pPoint argument). dOrientation indicates the direction of movement at the time the geographic coordinates were determined. The valid values are within the range 0 - 360 degrees (0 inclusive) clockwise starting from north at 0 degrees (i.e. 0 - north, 90 - east, 180 -  south, and 270 - west).
The street that the Flag being created is snapped to, will be the closest among those streets that have an orientation within dTolerance degrees of the dOrientation argument.

The pdAdjustedOrientation value represents the orientation of the street segment in the direction of travel at the snapped geographic point. Valid values are within the range 0 - 360 degrees as described above.

The dSpeed argument indicates the speed of the point (in mph) at the time that the input geographic coordinates were determined.

The dLatency argument indicates how many milliseconds old the input geographic coordinates are. These two arguments (dSpeed and dLatency) are used to further adjust the snapped position of the point.
This is accomplished by adjusting the snapped point position along the street segment in the direction of travel. The adjusted distance along the segment is determined by calculating the additional distance of the point. This additional distance is estimated based on the dSpeed value in miles per hour and the dLatency value in milliseconds. The returned value is the adjusted geographic coordinates of the created flag.

Note: When the snapped geographic position is adjusted, it is not allowed to pass through an intersection. For instance, if the next intersection is within 2 seconds of travel (according to current speed and orientation), and the latency value is greater than 2 seconds, the adjusted geographic point will be the intersection's coordinate.

See Also