TSLOWSContext Class Reference

Detailed Description

This class represents an OWS context document.

Classes
class	Information

Public Types
enum	FormatEnum { Atom }

Public Member Functions
	TSLOWSContext ()
	~TSLOWSContext ()
const TSLEntity *	areaOfInterest () const
const TSLCoordinateSystem *	areaOfInterestSRS () const
void	destroy ()
Information &	information ()
const Information &	information () const
bool	load (const char *filename)
bool	loadFromBuffer (const unsigned char *buffer, unsigned int length)
unsigned int	numResources () const
TSLOWCResource *	resource (unsigned int index)
bool	saveAtom (const char *filename)
void *	operator new (size_t size) TSL_NO_THROW
void *	operator new (size_t size, char *filename, int line)

Static Public Member Functions
static TSLOWSContext *	createFromSurface (TSLDrawingSurface *surface)

Member Enumeration Documentation

FormatEnum

enum TSLOWSContext::FormatEnum

Defines the supported formats when writing a context document.

Enumerator
Atom	The context document will be written in Atom (RFC 4287) format.

Constructor & Destructor Documentation

TSLOWSContext()

TSLOWSContext::TSLOWSContext

(

)

~TSLOWSContext()

TSLOWSContext::~TSLOWSContext

(

)

Member Function Documentation

areaOfInterest()

const TSLEntity * TSLOWSContext::areaOfInterest

(

)

const

Returns the area of interest of the context document. This area may be a point, rectangle or polygon.

This extent may be different to the extent of the data referenced by the context document.

areaOfInterestSRS()

const TSLCoordinateSystem * TSLOWSContext::areaOfInterestSRS

(

)

const

Returns the coordinate system that the area of interest is defined in.

createFromSurface()

static TSLOWSContext * TSLOWSContext::createFromSurface ( TSLDrawingSurface * surface )

static

Reserved for future use. This method always returns NULL.

destroy()

void TSLOWSContext::destroy

(

)

Destroy method for context documents. This should be called rather than deleting the object as the calls are redirected internally to MapLink.

information() [1/2]

Information & TSLOWSContext::information

(

)

Returns general information about the OWS context document.

information() [2/2]

const Information & TSLOWSContext::information

(

)

const

Returns general information about the OWS context document.

load()

bool TSLOWSContext::load

(

const char *

filename

)

Loads the context document referenced by the given filename.

Parameters

filename

The context document to open.

Returns

true if the file was opened, false otherwise.

loadFromBuffer()

bool TSLOWSContext::loadFromBuffer	(	const unsigned char *	buffer,
		unsigned int	length )

Loads a context document from an existing memory buffer.

All file references within the context document must be absolute. Any relative file references will fail to load.

Parameters

buffer	A pointer to the start of the buffer. The application retains ownership of this buffer.
length	The length of the buffer.

Returns

true if the context document was opened, false otherwise

numResources()

unsigned int TSLOWSContext::numResources

(

)

const

Returns the number of resources contained within the context document.

operator new() [1/2]

void * TSLOWSContext::operator new

(

size_t

size

)

Overridden allocation to redirect to MapLink

operator new() [2/2]

void * TSLOWSContext::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.

resource()

TSLOWCResource * TSLOWSContext::resource

(

unsigned int

index

)

Returns the resource at the given index.

The OWS context document retains ownership of the resource.

saveAtom()

bool TSLOWSContext::saveAtom

(

const char *

filename

)

Reserved for future use. This method always returns false.