IlvMapTileLoader Class Reference

The base abstract class for tile loaders specialized in loading map formats. More...

#include <ilviews/maps/format/maptloader.h>

Inheritance diagram for IlvMapTileLoader:

List of all members.

Public Member Functions
virtual IlvFeatureRenderer *	getDefaultFeatureRenderer (IlvDisplay *display)=0
	Returns the default feature renderer used for the rendering of map features of the current tile.
virtual IlvMapFeatureIterator *	getFeatureIterator (IlvTile *tile)=0
	Returns the feature iterator to read features for the specified tile.
virtual IlvFeatureRenderer *	getFeatureRenderer (IlvDisplay *display)
	Returns the renderer to use with this tile loader.
IlvMapsError	getInitStatus () const
	Checks the initialization status of this tile loader.
virtual IlvMapInfo *	getMapInfo ()=0
	Returns the IlvMapInfo used to generate the IlvGraphic objects.
virtual IlBoolean	isAttachingAttributes () const
	Test if this tile loader is attaching attributes.
IlBoolean	isOwnerOfRenderer () const
	Returns whether the tile loader is owner of its feature renderer or not.
virtual IlBoolean	isPersistent () const =0
	Returns IlTrue if this tile loader must be saved by a tile controller.
virtual IlvMapsError	load (IlvTile *tile)
	Method called when a tile has to be loaded.
virtual void	release (IlvTile *tile)
	Releases the specified tile.
virtual void	setAttachingAttributes (IlBoolean set)
	Specifies whether this tile loader is attaching attributes to the graphic objects it loads.
virtual void	setFeatureRenderer (IlvFeatureRenderer *renderer, IlBoolean owner=IlFalse)
	Sets the renderer to use with this tile loader.
Protected Member Functions
	IlvMapTileLoader ()
	Constructor.
void	setInitStatus (IlvMapsError status)
	Sets the error status of the tile loader.

---

Detailed Description

The base abstract class for tile loaders specialized in loading map formats.

Library: ilvmaps

This default implementation of an IlvTileLoader can load data from any data set on which IlvMapFeatureIterator can be constructed for a given tile.
This default implementation can also take advantage of classes implementing IlvLookAheadFeatureIterator.

---

Constructor & Destructor Documentation

IlvMapTileLoader::IlvMapTileLoader

(

)

[protected]

Constructor.

This class can only be instantiated by subclasses.

---

Member Function Documentation

virtual IlvFeatureRenderer* IlvMapTileLoader::getDefaultFeatureRenderer

(

IlvDisplay *

display

)

[pure virtual]

Returns the default feature renderer used for the rendering of map features of the current tile.

This default feature renderer is used when the user does not set a feature renderer.

Parameters:

display

The IlvDisplay

Returns:

The default feature renderer.

Implemented in IlvGeoTIFFTileLoader, IlvImageTileLoader, and IlvShapeFileTileLoader.

virtual IlvMapFeatureIterator* IlvMapTileLoader::getFeatureIterator

(

IlvTile *

tile

)

[pure virtual]

Returns the feature iterator to read features for the specified tile.

Parameters:

tile

The tile to load.

Returns:

The feature iterator to load features for this tile, or 0 if no features are to be loaded.

Implemented in IlvGeoTIFFTileLoader, IlvImageTileLoader, and IlvShapeFileTileLoader.

virtual IlvFeatureRenderer* IlvMapTileLoader::getFeatureRenderer

(

IlvDisplay *

display

)

[virtual]

Returns the renderer to use with this tile loader.

Returns:

The renderer to use with this tile loader.

IlvMapsError IlvMapTileLoader::getInitStatus

(

)

const

Checks the initialization status of this tile loader.

Returns:

IlvMaps::NoError() if the initialization of this tile loader is successful, or an error code if an error occurred during the initalization.

virtual IlvMapInfo* IlvMapTileLoader::getMapInfo

(

)

[pure virtual]

Returns the IlvMapInfo used to generate the IlvGraphic objects.

Returns:

The IlvMapInfo used to generate the IlvGraphic objects.

Implemented in IlvGeoTIFFTileLoader, IlvImageTileLoader, and IlvShapeFileTileLoader.

virtual IlBoolean IlvMapTileLoader::isAttachingAttributes

(

)

const [virtual]

Test if this tile loader is attaching attributes.

Returns:

IlTrue if this tile loader is attaching attributes to the graphic objects it loads, when these are available, and IlFalse otherwise. The default is IlTrue.

IlBoolean IlvMapTileLoader::isOwnerOfRenderer

(

)

const

Returns whether the tile loader is owner of its feature renderer or not.

See also:

IlvMapTileLoader::setFeatureRenderer

virtual IlBoolean IlvMapTileLoader::isPersistent

(

)

const [pure virtual]

Returns IlTrue if this tile loader must be saved by a tile controller.

Returns:

IlTrue if this tile loader must be saved.

Implements IlvTileLoader.

Implemented in IlvGeoTIFFTileLoader, IlvImageTileLoader, and IlvShapeFileTileLoader.

virtual IlvMapsError IlvMapTileLoader::load

(

IlvTile *

tile

)

[virtual]

Method called when a tile has to be loaded.

The default implementation gets the feature iterator for the tile to load by using getFeatureIterator(), and then adds all the objects to the tile using the feature renderer of this tile loader.
If getFeatureIterator() returns 0, the specified tile is assumed to be inexistent and tile->loadComplete() is called.

Parameters:

tile

The tile to load.

Returns:

An IlvMapsError if an error occurs when loading objects from the specified tile.

Implements IlvTileLoader.

virtual void IlvMapTileLoader::release

(

IlvTile *

tile

)

[virtual]

Releases the specified tile.

The default implementation calls tile->deleteAll()

Parameters:

tile

The tile to release.

Implements IlvTileLoader.

virtual void IlvMapTileLoader::setAttachingAttributes

(

IlBoolean

set

)

[virtual]

Specifies whether this tile loader is attaching attributes to the graphic objects it loads.

Parameters:

set

If IlTrue, attributes are attached.

virtual void IlvMapTileLoader::setFeatureRenderer	(	IlvFeatureRenderer *	renderer,
		IlBoolean	owner = IlFalse
	)			[virtual]

Sets the renderer to use with this tile loader.

Parameters:

	renderer	The feature renderer.
	owner	If this parameter is set to IlTrue, then the tile loader destructor will delete the renderer passed as first argument.

void IlvMapTileLoader::setInitStatus

(

IlvMapsError

status

)

[protected]

Sets the error status of the tile loader.

Parameters:

status

The initialization error code.