RouteTrak API
CRTEngine::RTInitialize
CRTEngine | See Also
RTERROR RTInitialize(int iPort, int iBaud = 38400, GPSPROTOCOL gpProtocol = GPSPROTOCOL_NMEA, GPSRECEIVER grReceiver = GPSRECEIVER_EMTAC, BOOL fStartGPS = FALSE, int iMinMovement = 0);
Parameters
Parameters Description
iPort The communications port number that the Engine will use to communicate with the GPS receiver
iBaud The baud rate that the Engine will use to communicate with the GPS receiver
gpProtocol The protocol that the Engine will use to communicate with the GPS receiver
grReceiver The GPS receiver type
fStartGPS Specifies whether to start the GPS communcations immediately (TRUE), or wait until RTGpsStart is called
iMinMovement Specifies the minimum distance, in feet to be considered as motion. The RouteTrak Engine will not log data records unless this criteria has been met

Return Values
Return Values Description
RTE_NONE No errors
RTE_GPS_INVALID_PORT Invalid port specified
RTE_GPS_INVALD_PROTOCOL Invalid protocol specified
RTE_GPS_INVALID_RECEIVER Invalid receiver specified
Description
Initializes the RouteTrak Engine
Remarks
  • The application must call this method before data collection can begin.

  • Setting fStartGPS to true begins the GPS messaging immediately. Alternately, setting this parameter to FALSE can give the application a chance to prepare to handle the messages, and GPS can be started later by calling RTGpsStart.

  • During development it can be helpful to set iMinMovement to zero. If the receiver does not move and this parameter is non-zero, no data will be collected, making it difficult to debug the application.

  • When the application is distributed, setting iMinimumMovement to an appropriate non-zero value can significantly reduce the size of the log file.
See Also
Class
Links

Copyright (c) 2001-2004 Links Point Inc.