TSLWMSGetFeatureInfoResponse Class Reference

Detailed Description

GetFeatureInfo response representation.

The GeatureFeatureInfo response object is used to pass a block of memory, usually containing text, back to the caller. Initially this response will contain no allocated memory until the initialise method is called. Once this takes place, the pointer to the memory can be retrieved from the getMemoryPtr method.

Public Member Functions
TSLWMSResponseCacheability	cacheability () const
void	cacheability (TSLWMSResponseCacheability value)
TSLDrawingSurface *	getDrawingSurface ()
unsigned int	getMemorySize () const
const char *	getReponseFormat () const
unsigned char *	getMemoryPtr ()
bool	initialise (unsigned int memorySize, const char *responseFormat)
void	releaseDrawingSurface ()
void	resizeMemory (unsigned int newSize)
void	setResponseFormat (const char *format)

Member Function Documentation

cacheability() [1/2]

TSLWMSResponseCacheability TSLWMSGetFeatureInfoResponse::cacheability

(

)

const

Queries the cacheability of the response. This may have been set by a previous WMS plugin that also drew to the response. Plugins should merge their cachability with the existing status of this flag.

cacheability() [2/2]

void TSLWMSGetFeatureInfoResponse::cacheability

(

TSLWMSResponseCacheability

value

)

Sets the cacheability of the response. This may have been set by a previous WMS plugin that also drew to the response. Plugins should merge their cachability with the existing status of this flag.

Parameters

value

The new value to set this flag to.

getDrawingSurface()

TSLDrawingSurface * TSLWMSGetFeatureInfoResponse::getDrawingSurface

(

)

Returns a Drawing Surface that can be used with the associated Response.

On return from the response the drawing surface should have had all the added layers removed.

This method may return NULL. If it does you will need to create a Drawing Surface within the plugin and handle the threading locally.

getMemoryPtr()

unsigned char * TSLWMSGetFeatureInfoResponse::getMemoryPtr

(

)

Queries the current pointer of the memory block contained in the response.

Initially this will be null until the initialise method is called. If the size created during the initialise method is incorrect, the resizeMemory method may be used to change the memory allocation. The original memory allocation will be lost, so it must be requeried via this method.

getMemorySize()

unsigned int TSLWMSGetFeatureInfoResponse::getMemorySize

(

)

const

Queries the current size of the memory block contained in the response.

Initially this will be 0 until the initialise method is called. If the size created during the initialise method is incorrect, the resizeMemory method may be used to change the memory allocation.

getReponseFormat()

const char * TSLWMSGetFeatureInfoResponse::getReponseFormat

(

)

const

Queries the currently set format of this response. This should have been set during the initial initialise method call, but can be subsequently changed via the setResponseFormat method. Its value should correspond to one of the formats registered with the TSLWMSRegister::declareGetFeatureFormat method.

initialise()

bool TSLWMSGetFeatureInfoResponse::initialise	(	unsigned int	memorySize,
		const char *	responseFormat )

The GeatureFeatureInfo response object is used to pass a block of memory, usually containing text, back to the caller. Initially this response will contain no allocated memory until the initialise method is called. Once this takes place, the pointer to the memory can be retrieved from the getMemoryPtr method.

Parameters

memorySize	The size of the block of memory to allocate.
responseFormat	The format of this response. This should correspond to one of the formats registered with the TSLWMSRegister::declareGetFeatureFormat method.

Returns

true on success, false otherwise.

releaseDrawingSurface()

void TSLWMSGetFeatureInfoResponse::releaseDrawingSurface

(

)

Releases the drawing surface, obtained using the getDrawingSurface method, back to the pool of available surfaces. This will take place automatically once the getMap method returns, but it can improve performance to return it early if suitable.

resizeMemory()

void TSLWMSGetFeatureInfoResponse::resizeMemory

(

unsigned int

newSize

)

The GeatureFeatureInfo response object is used to pass a block of memory, usually containing text, back to the caller. Initially this response will contain no allocated memory until the initialise method is called. Once this takes place, the pointer to the memory can be retrieved from the getMemoryPtr method.

It may be necessary however, to change the size of the memory allocation, which is where this method can be used. The old memory allocation will be lost, including its contents, and replaced with a new one of the size passed.

Parameters

newSize

The new size of the block of memory to allocate.

setResponseFormat()

void TSLWMSGetFeatureInfoResponse::setResponseFormat

(

const char *

format

)

Used to set the format of the response. This should correspond to one of the formats registered with the TSLWMSRegister::declareGetFeatureFormat method.

Parameters

format

The format to set.