TPosLmSortPref Class Reference

#include <mw/EPos_TPosLmSortPref.h>

Link against: eposlandmarks.lib

class TPosLmSortPref

Public Member Enumerations
enum	TSortOrder { EAscending, EDescending }

Public Member Functions
	TPosLmSortPref(CPosLandmark::TAttributes, TSortOrder)
IMPORT_C CPosLandmark::TAttributes	LandmarkAttributeToSortBy()
IMPORT_C void	SetSortByLandmarkAttribute(CPosLandmark::TAttributes, TSortOrder)
IMPORT_C TSortOrder	SortOrder()

Detailed Description

Class for specifying sort preference.

A sort pref object can be passed to some listing and searching functions in the API, to specify a sorting order for the returned landmark list.

Landmark sorting is not case sensitive.

Specifies the sort order.

Enumerator	Value	Description
EAscending	0	Ascending sort order
EDescending		Descending sort order

C++ constructor.

Only one landmark attribute can be specified here, not a bitmap of landmark attributes.

Landmark sorting is not case sensitive.

panic: "Landmarks Client"-EPosNoneOrMultipleLandmarkAttributeSet More than one attribute is specified or no attributes at all.

Parameter	Description
aLandmarkAttribute	The landmark attribute to sort by.
aSortOrder	Ascending or descending sort order.

LandmarkAttributeToSortBy

(

)

const

Gets the landmark attribute to sort by.

Returns: The landmark attribute to sort by, or CPosLandmark::ENoAttribute, if sort is not done by landmark attribute.

IMPORT_C void	SetSortByLandmarkAttribute	(	CPosLandmark::TAttributes	aLandmarkAttribute,
			TSortOrder	aSortOrder = EAscending
		)

Sets the landmark attribute to sort by.

Landmark sorting is not case sensitive.

panic: "Landmarks Client"-EPosNoneOrMultipleLandmarkAttributeSet More than one attribute is specified or no attributes at all.

Parameter	Description
aLandmarkAttribute	The landmark attribute to sort by.
aSortOrder	The preferred sort order.

SortOrder

(

)

const

Gets the preferred sort order.

Returns: The preferred sort order.