Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::TrafficReplay Class Reference

Traffic replay object. More...

Inheritance diagram for gem::TrafficReplay:
Collaboration diagram for gem::TrafficReplay:

Public Member Functions

 TrafficReplay (int id)
 Default constructor.
 TrafficReplay (const TrafficReplay &)=delete
 TrafficReplay (TrafficReplay &&repl)=default
 Default move constructor noexcept is deduced.
TrafficReplayoperator= (const TrafficReplay &)=delete
TrafficReplayoperator= (TrafficReplay &&repl)=default
 Default move assignment noexcept is deduced.
int getId () const noexcept
 get the id
void setListener (TrafficReplayListener listener) noexcept
 set the listener
int start (const String &addr, const Time &startUTC, const StringList &iso, float replayFactor) noexcept
 start the traffic replay
int update (const String &addr) noexcept
 update the traffic replay
int updateSpeeds (const String &addr) noexcept
 update the traffic replay speeds
void stop (const String &addr) noexcept
 stop the traffic replay
void pause (const String &addr) noexcept
 pause the traffic replay
void resume (const String &addr) noexcept
 resume the traffic replay
void getState (const String &addr) noexcept
 get the state
void getCountries (const String &addr) noexcept
 get the country list
bool isBusy () const noexcept
 check if the traffic replay is busy
bool getGPSTime (Time &time) const noexcept
 get the GPS time
const IOpenLRInfodisplayOpenLRInfo (const String &sentence) const noexcept
 display OpenLR information
const IOpenLRInfogetOpenLRInfo () const noexcept
 get OpenLR information
void hideOpenLRInfo () const noexcept
 hide OpenLR information

Static Public Member Functions

static void setTrafficUrl (const String *sUrl) noexcept
 set the traffic server url
static void getTrafficUrls (StringList &Url) noexcept
 get the traffic server urls
static void getTrafficFindUrl (String &Url, int id) noexcept
 get the traffic server find url
static void getTrafficFindXDSUrl (String &Url, LargeInteger linkUuid) noexcept
 get an URL for searching an XD segment by id
static void getTrafficStatUrl (String &sUrl) noexcept
 get the traffic server stat url
static void setWorkingTrafficServer (const TrafficReplay *pServer) noexcept
 set working traffic server
static String getFailedRoadblocksURL () noexcept
 get the failed roadblocks url

Protected Types

using Base = ApiObject<ITrafficReplay, false>
 Alias for the base class.

Detailed Description

Traffic replay object.

Constructor & Destructor Documentation

◆ TrafficReplay() [1/2]

gem::TrafficReplay::TrafficReplay ( int id)
inline

Default constructor.

Parameters
idThe id of the traffic replay

◆ TrafficReplay() [2/2]

gem::TrafficReplay::TrafficReplay ( TrafficReplay && repl)
default

Default move constructor noexcept is deduced.

Parameters
replThe traffic replay to move

Member Function Documentation

◆ displayOpenLRInfo()

const IOpenLRInfo * gem::TrafficReplay::displayOpenLRInfo ( const String & sentence) const
inlinenoexcept

display OpenLR information

Parameters
sentenceThe sentence
Returns
The OpenLR information

◆ getCountries()

void gem::TrafficReplay::getCountries ( const String & addr)
inlinenoexcept

get the country list

Parameters
[out]addrThe address

◆ getFailedRoadblocksURL()

String gem::TrafficReplay::getFailedRoadblocksURL ( )
inlinestaticnoexcept

get the failed roadblocks url

Returns
The failed roadblocks url

◆ getGPSTime()

bool gem::TrafficReplay::getGPSTime ( Time & time) const
inlinenoexcept

get the GPS time

Parameters
[out]timeThe GPS time
Returns
True if the GPS time is available

◆ getId()

int gem::TrafficReplay::getId ( ) const
inlinenoexcept

get the id

Returns
The id

◆ getOpenLRInfo()

const IOpenLRInfo * gem::TrafficReplay::getOpenLRInfo ( ) const
inlinenoexcept

get OpenLR information

Returns
The OpenLR information

◆ getState()

void gem::TrafficReplay::getState ( const String & addr)
inlinenoexcept

get the state

Parameters
[out]addrThe address

◆ getTrafficFindUrl()

void gem::TrafficReplay::getTrafficFindUrl ( String & Url,
int id )
inlinestaticnoexcept

get the traffic server find url

Parameters
[out]UrlThe traffic server find url
idThe id of the traffic server

◆ getTrafficFindXDSUrl()

void gem::TrafficReplay::getTrafficFindXDSUrl ( String & Url,
LargeInteger linkUuid )
inlinestaticnoexcept

get an URL for searching an XD segment by id

Parameters
[out]UrlThe traffic server find url
linkUuidThe link id

◆ getTrafficStatUrl()

void gem::TrafficReplay::getTrafficStatUrl ( String & sUrl)
inlinestaticnoexcept

get the traffic server stat url

Parameters
[out]sUrlThe traffic server stat url

◆ getTrafficUrls()

void gem::TrafficReplay::getTrafficUrls ( StringList & Url)
inlinestaticnoexcept

get the traffic server urls

Parameters
[out]UrlThe list of traffic server urls

◆ isBusy()

bool gem::TrafficReplay::isBusy ( ) const
inlinenoexcept

check if the traffic replay is busy

Returns
True if the traffic replay is busy

◆ operator=()

TrafficReplay & gem::TrafficReplay::operator= ( TrafficReplay && repl)
default

Default move assignment noexcept is deduced.

Parameters
replThe traffic replay to move
Returns
The moved traffic replay

◆ pause()

void gem::TrafficReplay::pause ( const String & addr)
inlinenoexcept

pause the traffic replay

Parameters
addrThe address

◆ resume()

void gem::TrafficReplay::resume ( const String & addr)
inlinenoexcept

resume the traffic replay

Parameters
addrThe address

◆ setListener()

void gem::TrafficReplay::setListener ( TrafficReplayListener listener)
inlinenoexcept

set the listener

Parameters
listenerThe listener

◆ setTrafficUrl()

void gem::TrafficReplay::setTrafficUrl ( const String * sUrl)
inlinestaticnoexcept

set the traffic server url

Parameters
sUrlThe traffic server url

◆ setWorkingTrafficServer()

void gem::TrafficReplay::setWorkingTrafficServer ( const TrafficReplay * pServer)
inlinestaticnoexcept

set working traffic server

Parameters
pServerThe working traffic server

◆ start()

int gem::TrafficReplay::start ( const String & addr,
const Time & startUTC,
const StringList & iso,
float replayFactor )
inlinenoexcept

start the traffic replay

Parameters
addrThe address
startUTCThe start UTC time
isoThe list of ISO codes
replayFactorThe replay factor
Returns
The result

◆ stop()

void gem::TrafficReplay::stop ( const String & addr)
inlinenoexcept

stop the traffic replay

Parameters
addrThe address

◆ update()

int gem::TrafficReplay::update ( const String & addr)
inlinenoexcept

update the traffic replay

Parameters
addrThe address
Returns
The result

◆ updateSpeeds()

int gem::TrafficReplay::updateSpeeds ( const String & addr)
inlinenoexcept

update the traffic replay speeds

Parameters
addrThe address
Returns
The result