TSLFeatureClassList Class Reference

Detailed Description

Feature list accessor class.

The TSLFeatureClassList component gives access to the feature list related to a TSLDataLayer derived component.

The TSLDataLayer::featureList() method returns a read-only pointer to a TSLFeatureClassList object. This object is embedded within the TSLDataLayer and should not be deleted.

Any modifications to the featureList may invalidate the pointer, or change the order of items in the list.

Public Member Functions
const char *	getDetails (int index, TSLFeatureID *id) const
TSLFeatureID	getID (const char *name) const
const char *	getName (TSLFeatureID id) const
int	getSourceInfoCount (const char *featureName, TSLFeatureID featureID) const
bool	getSourceInfoItem (const char *featureName, TSLFeatureID featureID, int index, TSLSimpleString *sourceName, TSLFeatureID *sourceFeatureID, TSLSimpleString *sourceDescription, TSLGeometryType *sourceType, int *minOccurs, int *maxOccurs) const
int	size () const

Member Function Documentation

getDetails()

const char * TSLFeatureClassList::getDetails	(	int	index,
		TSLFeatureID *	id ) const

Get details of item at specified index.

Parameters

index	Index into list to access.
id	Storage for ID.

Returns

name of feature class, NULL on error.

getID()

TSLFeatureID TSLFeatureClassList::getID

(

const char *

name

)

const

Get feature ID from feature name.

Parameters

name	name of feature

Returns

ID of feature, 0 on error.

getName()

const char * TSLFeatureClassList::getName

(

TSLFeatureID

id

)

const

Get feature name from feature ID.

Parameters

id	ID of feature

Returns

name of feature, NULL on error.

getSourceInfoCount()

int TSLFeatureClassList::getSourceInfoCount	(	const char *	featureName,
		TSLFeatureID	featureID ) const

Returns the number of source information items which have been associated with the specified feature class.

Note: Either a valid feature name or feature ID need to be specified. It is not required to provide both.

Parameters

featureName	The name of the feature class.
featureID	The name of the feature class.

getSourceInfoItem()

bool TSLFeatureClassList::getSourceInfoItem	(	const char *	featureName,
		TSLFeatureID	featureID,
		int	index,
		TSLSimpleString *	sourceName,
		TSLFeatureID *	sourceFeatureID,
		TSLSimpleString *	sourceDescription,
		TSLGeometryType *	sourceType,
		int *	minOccurs,
		int *	maxOccurs ) const

Returns the source information attached to the feature class at the given index.

Note: Either a valid feature name or feature ID need to be specified. It is not required to provide both.

Parameters

featureName	The name of the feature class to retrieve the source information from.
featureID	The name of the feature class to retrieve the source information from.
index	The index of the item to retrieve.
sourceName	A TSLSimpleString which will be populated with the name of the source data.
sourceFeatureID	This will be populated with the ID of the source data.
sourceDescription	A TSLSimpleString which will be populated with the description of the source data.
sourceType	This will be populated with the type of the source data.
minOccurs	This will be populated with the minimum number of occurrences of the source data. Usually this will be 1.
maxOccurs	This will be populated with the maximum number of occurrences of the source data. Usually this will be 1.

Returns

true on success, false otherwise.

size()

int TSLFeatureClassList::size

(

)

const

Returns number of feature classes in the list.