AifMapChartDataSource Class Reference

#include <gls_map_aif.h>

Inheritance diagram for AifMapChartDataSource:

Public Member Functions
	AifMapChartDataSource (bool UseDefaultCache=true)
	~AifMapChartDataSource ()
	Destructs a AifMapChartDataSource object.
void	LoadAifFile (std::string filename)
virtual void	SetCache (AIFMapChartLayerCache &cache)
bool	GetAvailableCoverage (GeoRect *dest) DISTI_METHOD_OVERRIDE
	See base class.
void	GetCellList (const GeoRect &coverage, unsigned long layerID, double viewLogicalHeight, double viewGeoHeight, MapChartCellList &viewList) DISTI_METHOD_OVERRIDE
	See base class.
void	AddOverlay (const std::string &overlay, double resolution)
void	InsertOverlay (int index, const std::string &overlay, double resolution)
void	RemoveOverlay (const std::string &overlay, double resolution)
void	RemoveOverlay (const std::string &overlay)
void	RemoveOverlay (double resolution)
void	SetCacheSize (const float memSize)
float	GetCacheSize () const
	Get the cached size (megabytes) of images.
float	GetCurrentCacheAllocated ()
	Get the amount of memory used.
void	InstallViewManager (AIFViewManager &mgr)
void	UninstallViewManager ()
	Uninstall the view manager.
void	PreCache (const GeoRect &area)
void	PreCache (const double resolution)
void	SetTargetCellLoadRate (const double targetCellLoadRate)
double	GetTargetCellLoadRate () const
Public Member Functions inherited from GlsMapChartDataSource
virtual	~GlsMapChartDataSource ()
	Destructor for abstract base class.
virtual unsigned long	GetBestLayer (GlsMapView *view, GlsMapChart *chart) const
virtual void	PostDraw (GlsMapView *view, GlsMapChart *chart)
virtual bool	AreAllCellsLoaded (GlsMapView *view, GlsMapChart *chart)

Protected Attributes
OverlayCellMultiMap	_cells
	The multimap containing all loaded cells for this Map Chart Data Source.
ResolutionList	_resolutionList
GeoRect	_extents
	The lat/lon boundries of the data contained in this Map Chart Data Source.
OverlayListType	_overlayList
	A list of all currently displayed overlay layers.
AIFMapChartLayerCache *	_pCache
	The cache.
AIFViewManager *	_pViewMgr
	The View manager.
bool	_usingDefaultCache
	Using default cache.

Additional Inherited Members
Protected Member Functions inherited from GlsMapChartDataSource
	GlsMapChartDataSource ()
	Constructor for subclasses.

Detailed Description

Runtime implementation of an AifMapChartDataSource

Constructor & Destructor Documentation

AifMapChartDataSource

(

bool

UseDefaultCache = true

)

Create a new AifMapChartDataSource.

Parameters

UseDefaultCache

whether to use the default caching system. See AIFMapChartLayerCache for more information

Member Function Documentation

void AddOverlay	(	const std::string &	overlay,
		double	resolution
	)

Add an overlay layer to the list of layers to display.

Parameters

overlay	The name of the overlay layer to display. Must correspond to an overlay defined in the AIF file.
resolution	The resolution of the overlay to display. Must correspond to a resolution of an overlay defined in the AIF file.

double GetTargetCellLoadRate

(

)

const

Get the target rate in hz at which cells will be loaded

Returns

target rate in hz else 0.0 for no target rate ( i.e. load as quickly as possible )

void InsertOverlay	(	int	index,
		const std::string &	overlay,
		double	resolution
	)

Insert an overlay layer to the list of layers to display at the given position.

Parameters

index	The index to insert the overlay at, if -1 or greater than the length of the overlay list then inserts at end.
overlay	The name of the overlay layer to display. Must correspond to an overlay defined in the AIF file.
resolution	The resolution of the overlay to display. Must correspond to a resolution of an overlay defined in the AIF file.

void InstallViewManager

(

AIFViewManager &

mgr

)

Install the view manager. The view manager (after being initialized by the user) will set this class up to add/remove overlays automatically based on the view height

Parameters

mgr	Manager to install

void LoadAifFile

(

std::string

filename

)

Load an AIF File with the given file name.

Parameters

filename

The name of the AIF file to load. Can be absolute or relative to the executing directory.

void PreCache

(

const GeoRect &

area

)

Precache based on geo-rect area. This uses the AIFMapChartCache as the mechanism to precache images

Parameters

area	Geometric rect area to pre-cache

void PreCache

(

const double

resolution

)

Precache based on resolution

Parameters

resolution

Resolution to precache at.

void RemoveOverlay	(	const std::string &	overlay,
		double	resolution
	)

Remove an overlay layer from the list of layers to display.

Parameters

overlay	The name of the overlay layer to remove. Must correspond to an overlay defined in the AIF file.
resolution	The resolution of the overlay to remove. Must correspond to a resolution of an overlay defined in the AIF file.

void RemoveOverlay

(

const std::string &

overlay

)

Remove all overlay layers with the given overlay name.

Parameters

overlay

The name of the set of overlay layers to remove.

void RemoveOverlay

(

double

resolution

)

Remove all overlay layers with the given resolution.

Parameters

resolution

The resolution of the set of overlay layers to remove.

virtual void SetCache ( AIFMapChartLayerCache &  cache )

virtual

If using custom cache, set it here. Caller responsible for its deallocation if necessary

Parameters

cache

Custom cache to use

void SetCacheSize

(

const float

memSize

)

Parameters

memSize

Set the cached size (megabytes) of images

void SetTargetCellLoadRate

(

const double

targetCellLoadRate

)

Set the target rate in hz at which cells will be loaded

Parameters

targetCellLoadRate

target rate in hz else 0.0 for no target rate ( i.e. load as quickly as possible )

Member Data Documentation

ResolutionList _resolutionList

protected

A list of the resolutions in this AIF file for speeding up the selection of a resolution at cell load list time.

---

The documentation for this class was generated from the following file:

• gls_map_aif.h