TSLTerrainDataItem Class Reference

Detailed Description

This structure is passed in empty to the query methods of TSLTerrainDatabase and if data is available, it is filled with terrain information on return.

Public Member Functions
	TSLTerrainDataItem ()
	TSLTerrainDataItem (const TSLTerrainDataItem &other)
	~TSLTerrainDataItem ()

Public Attributes
double	m_x
double	m_y
double	m_z
bool	m_isNull
double	m_xResolution
double	m_yResolution
double	m_nearestX
double	m_nearestY
double	m_nearestZ
bool	m_nearestIsNull

Constructor & Destructor Documentation

TSLTerrainDataItem() [1/2]

TSLTerrainDataItem::TSLTerrainDataItem

(

)

TSLTerrainDataItem() [2/2]

TSLTerrainDataItem::TSLTerrainDataItem

(

const TSLTerrainDataItem &

other

)

~TSLTerrainDataItem()

TSLTerrainDataItem::~TSLTerrainDataItem

(

)

Member Data Documentation

m_isNull

bool TSLTerrainDataItem::m_isNull

Set to true if the height for the position is invalid. The m_z will be set to 0 if true.

This data is always valid after a successful call to any of the query functions.

m_nearestIsNull

bool TSLTerrainDataItem::m_nearestIsNull

Allows the caller to determine if the nearest data reading to the requested location is null or not. The nearest data reading is null if this flag is set.

This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.

m_nearestX

double TSLTerrainDataItem::m_nearestX

Returns the X position of the nearest actual data reading.

This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.

m_nearestY

double TSLTerrainDataItem::m_nearestY

Returns the Y position of the nearest actual data reading.

This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.

m_nearestZ

double TSLTerrainDataItem::m_nearestZ

Returns the height of the nearest actual data reading. Only valid if m_ nearestIsNull is false.

This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_Nearest bit set.

m_x

double TSLTerrainDataItem::m_x

m_x, m_y detail the position the data within the structure pertains to. The units are the Map Units as created in MapLink Studio.

This data is always valid after a successful call to any of the query functions.

m_xResolution

double TSLTerrainDataItem::m_xResolution

Contains information on the x resolution of the grid where the data was extracted from.

This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_HorizontalRes bit set.

m_y

double TSLTerrainDataItem::m_y

m_x, m_y detail the position the data within the structure pertains to. The units are the Map Units as created in MapLink Studio.

This data is always valid after a successful call to any of the query functions.

m_yResolution

double TSLTerrainDataItem::m_yResolution

Contains information on the y resolution of the grid where the data was extracted from.

This data is only valid after a successful call to any of the query functions if the filter parameter has the TSLTerrainData_HorizontalRes bit set.

m_z

double TSLTerrainDataItem::m_z

Contains the height information ranging from -32768 to 32767. The units depend upon the data within the terrain database but are generally in meters from mean sea level.

This data is always valid after a successful call to any of the query functions.