Public Member Functions | Protected Attributes

VgMyRemoteMapManager Class Reference

List of all members.

Public Member Functions

 VgMyRemoteMapManager (VgApplication::VgIApplication *pVgApplication, const VgMyRemoteMapManagerConfig &pConfig, const std::string &pLocalMapsDirectory, const std::string &pLocalTemporaryDirectory)
 Handles downloading of maps from the mapmanager (and mapeditor)
virtual ~VgMyRemoteMapManager ()
bool list ()
 Starts a list request.
bool downloadMap (unsigned int pMadID)
 start downloading a remote map.
bool getLocalConfigPathForMap (unsigned int pMapID, std::string &pOutConfigPath)
bool removeLocalMap (unsigned pMapID)
bool removeLocalMaps ()

Protected Attributes

VgMyRemoteMapManagerImpl * mPrivate

Constructor & Destructor Documentation

VgMyRemoteMapManager::VgMyRemoteMapManager ( VgApplication::VgIApplication *  pVgApplication,
const VgMyRemoteMapManagerConfig pConfig,
const std::string &  pLocalMapsDirectory,
const std::string &  pLocalTemporaryDirectory 
)

Handles downloading of maps from the mapmanager (and mapeditor)

Parameters:
pVgApplicationVgIApplication. Used to determine internal paths, and license information.
pConfigremote map manager configuration.
pLocalMapsDirectorylocal Directory where the maps will be downloaded.
pLocalTemporaryDirectorylocal temporary directory where the remote .zip file will be downloaded.
virtual VgMyRemoteMapManager::~VgMyRemoteMapManager (  ) [virtual]

Member Function Documentation

bool VgMyRemoteMapManager::downloadMap ( unsigned int  pMadID )

start downloading a remote map.

Remarks:
only one map can be downloaded at a time.
Parameters:
pMapIDmap id to download
Returns:
true if the request has been queued.
bool VgMyRemoteMapManager::getLocalConfigPathForMap ( unsigned int  pMapID,
std::string &  pOutConfigPath 
)
Parameters:
pMapIDmap id of the relevant map.
pOutConfigPathoutput parameter that will contain the vg_config path for a given map id.
Returns:
true if the path exists and pOutConfigPath was filled.
bool VgMyRemoteMapManager::list (  )

Starts a list request.

Returns:
false, if there is a network activity already in progress
bool VgMyRemoteMapManager::removeLocalMap ( unsigned  pMapID )
bool VgMyRemoteMapManager::removeLocalMaps (  )

Member Data Documentation

VgMyRemoteMapManagerImpl* VgMyRemoteMapManager::mPrivate [protected]

The documentation for this class was generated from the following file:
VisioDevKit 2.0, Visioglobe® 2013