TSLNationalGridDataLayer Class Reference

Inheritance diagram for TSLNationalGridDataLayer:

Detailed Description

Specialist data layer for the display of the British National grid.

This adds special features to allow configuration of the rendering. At present, these are features:

• 10001 : "xmajor" : Major X gridlines (vertical)
• 10002 : "ymajor" : Major Y gridlines (horizontal)
• 10003 : "xaxis" : X axis (horizontal, y=0)
• 10004 : "yaxis" : Y axis (vertical, x=0)
• 10005 : "label" : Label text within a tile. The scale parameter is a percentage of the tile height.

Use the setFeatureRendering method and setTextRendering methods to configure the rendering options for these.

Instances of this class should be destroyed using the destroy method.

Public Member Functions
	TSLNationalGridDataLayer ()
bool	gridSquare (const TSLEnvelope &extent, int scale, TSLSimpleString &gridSquareName)
bool	queryTileExtent (const char *tileName, TSLEnvelope &extent)
bool	setUnits (double tmcPerMetre, TSLTMC tmcXOrigin=0, TSLTMC tmcYOrigin=0)
void *	operator new (size_t size) TSL_NO_THROW
void *	operator new (size_t size, char *filename, int line)
Public Member Functions inherited from TSLDataLayer
void	addDrawingCallback (TSLDataLayerDrawingCallback *drawingCallback)
bool	addFeatureRendering (const char *featureName, TSLFeatureID featureID)
bool	addLoader (TSLFileLoader *loader, TSLLoaderAppCallback callback, void *arg, TSLAllLoadedCallback allLoadedCallback=0, void *arg2=0)
bool	addPathList (const TSLPathList *path_list)
void	cancelFlashback ()
bool	clearFeatureRendering (const char *featureName, TSLFeatureID featureID)
TSLDataHandler *	createDataHandler (const char *config_file=0)
TSLHistoryVersion	currentVersion () const
TSLDataHandler *	dataHandler ()
const TSLDataHandler *	dataHandler () const
void	destroy ()
bool	entityIsVisible (const TSLEntity *entity, const TSLDrawingSurface *drawingSurface) const
const TSLFeatureClassList *	featureList () const
const TSLFeatureClassList *	featureList (const char *detailLayerName) const
bool	fileModificationTime (const char *filename, TSLTimeType &lastModificationTime)
TSLEntity *	findEntity (TSLTMC x, TSLTMC y, TSLTMC aperture, int depth, const char *featureName=0, int drawingSurfaceID=-1)
bool	findFile (const char *filename, TSLSimpleString &foundPath) const
void	flashbackToTimestamp (TSLHistoryTimestamp timestamp, TSLLayerArchiveCallback archiveCallback, void *arg=0)
void	flashbackToTimestamp (TSLHistoryTimestamp timestamp, TSLLayerArchiveTileCallback archiveTileCallback, void *arg=0)
void	flashbackToVersion (TSLHistoryVersion version, TSLLayerArchiveCallback archiveCallback, void *arg=0)
void	flashbackToVersion (TSLHistoryVersion version, TSLLayerArchiveTileCallback archiveTileCallback, void *arg=0)
bool	getActiveLayerName (const TSLEnvelope &extent, double screenResolution, TSLSimpleString &activeLayerName) const
TSLEntityIterator *	getEntityIterator (const char *detailLayer, TSLSelector *selector=NULL, TSLEnvelope *extent=NULL, bool splitOptimisedPrimitives=true)
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeInt attribute, int *result) const
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeDouble attribute, double *result) const
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeBool attribute, bool *result) const
bool	getFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributes *result) const
TSLFileLoader *	getLoader ()
bool	getMUExtent (double *x1, double *y1, double *x2, double *y2, int drawingSurfaceID=-1) const
bool	getTMCExtent (TSLTMC *x1, TSLTMC *y1, TSLTMC *x2, TSLTMC *y2, int drawingSurfaceID=-1) const
bool	getUUExtent (double *x1, double *y1, double *x2, double *y2, const TSLDrawingSurface *drawingSurface) const
bool	importHistory (TSLHistoryVersion mapVersion, TSLHistoryTimestamp timestamp, TSLHistoryImportSet *historySet)
bool	latLongToTMC (double latitude, double longitude, TSLTMC *x, TSLTMC *y, bool local=false) const
bool	latLongToTMC (int num, double *latitudes, double *longitudes, TSLTMC *xs, TSLTMC *ys, bool local=false) const
TSLDataLayerTypeEnum	layerType () const
bool	loadData (const char *filename)
bool	loadRendering (const char *filename)
void	notifyChanged (bool changed=true)
TSLMapQuery *	query (TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, int depth=-1, const char *featureName=NULL, int drawingSurfaceID=-1) const
TSLMapQuery *	query (TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, TSLSelector *selector, int drawingSurfaceID=-1) const
const TSLCoordinateSystem *	getCoordinateSystem () const
bool	queryVersionHistory (const TSLEnvelope &extent, TSLVersionHistorySet &history)
void	refreshFlashback ()
bool	removeData ()
void	releaseResources (int surfaceID)
bool	saveRendering (const char *filename, TSLMapLinkVersion ver=TSL_CURRENT_MAPLINK_VERSION)
bool	setCoordinateSystem (const TSLCoordinateSystem *coordinateSystem)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeInt attribute, int value)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeDouble attribute, double value)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeBool attribute, bool value)
bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributes *value)
bool	TMCToLatLong (TSLTMC x, TSLTMC y, double *latitude, double *longitude, bool local=false, bool boundCheck=true) const
bool	TMCToLatLong (int num, TSLTMC *xs, TSLTMC *ys, double *latitudes, double *longitudes, bool local=false) const
const TSLVersionHistorySet *	versionHistory () const

Constructor & Destructor Documentation

TSLNationalGridDataLayer()

TSLNationalGridDataLayer::TSLNationalGridDataLayer

(

)

Default constructor

Member Function Documentation

gridSquare()

bool TSLNationalGridDataLayer::gridSquare	(	const TSLEnvelope &	extent,
		int	scale,
		TSLSimpleString &	gridSquareName )

This method calculates the matching grid name for the specified National Grid quadrant. If the extent does not match a national grid square then this method will return false.

Parameters

extent	The extent to convert to a national grid square name.
scale	The scale to use to determine the grid square name, e.g. 1250 will give names such as 'SU5516NW'
gridSquareName	This will be set to the name of the grid square.

operator new() [1/2]

void * TSLNationalGridDataLayer::operator new

(

size_t

size

)

Allocation override for API redirection

operator new() [2/2]

void * TSLNationalGridDataLayer::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

queryTileExtent()

bool TSLNationalGridDataLayer::queryTileExtent	(	const char *	tileName,
		TSLEnvelope &	extent )

Query the TMC extent of the specified OS grid tile.

Parameters

tileName	Name of tile to get extent for eg. "NT2772SW"
extent	Reference to be populated with extent of tile.

Returns

by value true if extent is populated, false otherwise.

setUnits()

bool TSLNationalGridDataLayer::setUnits	(	double	tmcPerMetre,
		TSLTMC	tmcXOrigin = 0,
		TSLTMC	tmcYOrigin = 0 )

Sets the grid units and offset.

Parameters

tmcPerMetre	This is the number of TMC units for a metre. Typically, this may be the TMCPerMU on a Map Data Layer.
tmcXOrigin	This is the origin of the grid X axis, in TMC coordinates. The default value is 0.
tmcYOrigin	This is the origin of the grid Y axis, in TMC coordinates. The default value is 0.

Returns

false on error, true otherwise.