TSLS52FeatureLookupUtility Class Reference

Detailed Description

The TSLS52FeatureLookupUtility enables the querying of S-57 feature classes and attribute names from a supplied feature catalogue.

An example feature catalogue is "IHOS57Catalogue_v31.xml" which can be found in the config directory of a standard MapLink installation.

Catalogues can be loaded via the loadFeatureCatalogue method.

Public Member Functions
	TSLS52FeatureLookupUtility ()
void	destroy ()
const char *	getAttributeName (const char *attributeCode) const
const char *	getObjectClass (const char *objectCode) const
bool	loadFeatureCatalogue (const char *featureCatalogueLocation)
void *	operator new (size_t _size) TSL_NO_THROW
void *	operator new (size_t _size, char *filename, int line)

Protected Member Functions
	~TSLS52FeatureLookupUtility ()

Constructor & Destructor Documentation

TSLS52FeatureLookupUtility()

TSLS52FeatureLookupUtility::TSLS52FeatureLookupUtility

(

)

Create a new feature lookup utility which enables querying of S52 feature classes and attribute names.

To query features a catalogue must first be loaded via the loadFeature Catalogue method.

~TSLS52FeatureLookupUtility()

TSLS52FeatureLookupUtility::~TSLS52FeatureLookupUtility ( )

protected

Protected destructor. The user should call 'destroy()' instead of delete to clear up the TSLS52FeatureLookupUtility.

Member Function Documentation

destroy()

void TSLS52FeatureLookupUtility::destroy

(

)

Destroys this TSLS52FeatureLookup instance. This function should be called instead of delete.

getAttributeName()

const char * TSLS52FeatureLookupUtility::getAttributeName

(

const char *

attributeCode

)

const

Retrieve the human readable attribute class from a 6 character S-57 attribute code.

Parameters

featureCode

The 6 character S-57 attribute code of the attribute to retrieve the human readable name for (e.g. "drval1").

Returns

the human readable attribute name on success or NULL otherwise.

getObjectClass()

const char * TSLS52FeatureLookupUtility::getObjectClass

(

const char *

objectCode

)

const

Retrieve the human readable object class from a 6 character S-57 object code.

Parameters

featureCode

The 6 character S-57 object code of the object to retrieve the human readable name for (e.g. "DEPARE").

Returns

the human readable object class on success or NULL otherwise.

loadFeatureCatalogue()

bool TSLS52FeatureLookupUtility::loadFeatureCatalogue

(

const char *

featureCatalogueLocation

)

Load a feature catalogue from which the feature and attribute names will be determined. Loading a new catalogue will remove all previous catalogue information.

Parameters

featureCatalogueLocation

The full path to the feature catalogue to load.

Returns

true on success, false otherwise.

operator new() [1/2]

void * TSLS52FeatureLookupUtility::operator new

(

size_t

_size

)

Allocation override for API redirection.

operator new() [2/2]

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