TSLTerrainViewShedData Class Reference

Detailed Description

Note: This class has been deprecated, and the functionality replaced. Please see the headers in 'MapLinkTerrainViewShed.h' and the 'MapLink Pro Developer's Guide' for more information. The MapLink Terrain Viewer sample application has been updated to demonstrate the usage of the new viewshed classes.

This class handles the results of a TSLTerrainViewShed calculateLineOfSight operation. It has an array of line of sight data and its dimensions.

Public Types
enum	LOSTriStateEnum { LOSTriStateNoData = 0 , LOSTriStateVisible = 1 , LOSTriStateNotVisible = 2 }

Public Member Functions
	TSLTerrainViewShedData (int numRows, int numColumns, int losOriginX, int losOriginY, double cellDistanceMUInX, double cellDistanceMUInY, LOSTriStateEnum *los, int *accurateLOS)
void	destroy ()
int *	getAccurateLos () const
double	getCellDistanceMUInX () const
double	getCellDistanceMUInY () const
LOSTriStateEnum *	getLos () const
int	getLosOriginX () const
int	getLosOriginY () const
int	getNumColumns () const
int	getNumRows () const
void	setAccurateLos (int *value)
void	setCellDistanceMUInX (double value)
void	setCellDistanceMUInY (double value)
void	setLos (LOSTriStateEnum *value)
void	setLosOriginX (int value)
void	setLosOriginY (int value)
void	setNumColumns (int value)
void	setNumRows (int value)

Protected Member Functions
	~TSLTerrainViewShedData ()

Protected Attributes
int *	m_accurateLOS
double	m_cellDistanceMUInX
double	m_cellDistanceMUInY
LOSTriStateEnum *	m_los
int	m_losOriginX
int	m_losOriginY
int	m_numColumns
int	m_numRows

Member Enumeration Documentation

LOSTriStateEnum

enum TSLTerrainViewShedData::LOSTriStateEnum

This tristate indicates the visibility of each terrain point.

LOSTriStateNoData - Currently only used to indicate that the data is outside the query extent. Reserved for future use.

LOSTriStateVisible - The point is visible

LOSTriStateNotVisible - The point is not visible

Enumerator
LOSTriStateNoData
LOSTriStateVisible
LOSTriStateNotVisible

Constructor & Destructor Documentation

TSLTerrainViewShedData()

TSLTerrainViewShedData::TSLTerrainViewShedData	(	int	numRows,
		int	numColumns,
		int	losOriginX,
		int	losOriginY,
		double	cellDistanceMUInX,
		double	cellDistanceMUInY,
		LOSTriStateEnum *	los,
		int *	accurateLOS )

~TSLTerrainViewShedData()

TSLTerrainViewShedData::~TSLTerrainViewShedData ( )

protected

Member Function Documentation

destroy()

void TSLTerrainViewShedData::destroy

(

)

Destroy TSLTerrainViewShedData object.

This method should be called by the user as soon as the data is not required.

getAccurateLos()

int * TSLTerrainViewShedData::getAccurateLos ( ) const

inline

Get the accurate line of sight data array. If the accurate flag was passed to the calculateLineOfSight method then use this to access the data.

Class TSLTerrainViewShedData

getCellDistanceMUInX()

double TSLTerrainViewShedData::getCellDistanceMUInX ( ) const

inline

Gets the distance in map units that each array cell covers.

getCellDistanceMUInY()

double TSLTerrainViewShedData::getCellDistanceMUInY ( ) const

inline

Gets the distance in map units that each array cell covers.

getLos()

TSLTerrainViewShedData::LOSTriStateEnum * TSLTerrainViewShedData::getLos ( ) const

inline

Get the standard line of sight data array

getLosOriginX()

int TSLTerrainViewShedData::getLosOriginX ( ) const

inline

Gets the start row in the terrain data that the calculation was performed on

getLosOriginY()

int TSLTerrainViewShedData::getLosOriginY ( ) const

inline

Gets the start column in the terrain data that the calculation was performed on

getNumColumns()

int TSLTerrainViewShedData::getNumColumns ( ) const

inline

Gets the number of columns in the line of sight data

getNumRows()

int TSLTerrainViewShedData::getNumRows ( ) const

inline

Gets the number of rows in the line of sight data

setAccurateLos()

void TSLTerrainViewShedData::setAccurateLos ( int * value )

inline

Set the accurate line of sight data array.

setCellDistanceMUInX()

void TSLTerrainViewShedData::setCellDistanceMUInX ( double value )

inline

Sets the distance in map units that each array cell covers.

setCellDistanceMUInY()

void TSLTerrainViewShedData::setCellDistanceMUInY ( double value )

inline

Sets the distance in map units that each array cell covers.

setLos()

void TSLTerrainViewShedData::setLos ( TSLTerrainViewShedData::LOSTriStateEnum * value )

inline

Set the line of sight data array.

setLosOriginX()

void TSLTerrainViewShedData::setLosOriginX ( int value )

inline

Sets the start row in the terrain data that the calculation was performed on

setLosOriginY()

void TSLTerrainViewShedData::setLosOriginY ( int value )

inline

Sets the start column in the terrain data that the calculation was performed on

setNumColumns()

void TSLTerrainViewShedData::setNumColumns ( int value )

inline

Sets the number of columns in the line of sight data

setNumRows()

void TSLTerrainViewShedData::setNumRows ( int value )

inline

Sets the number of rows in the line of sight data

Member Data Documentation

m_accurateLOS

int* TSLTerrainViewShedData::m_accurateLOS

protected

Data Members for Class Attributes

m_cellDistanceMUInX

double TSLTerrainViewShedData::m_cellDistanceMUInX

protected

m_cellDistanceMUInY

double TSLTerrainViewShedData::m_cellDistanceMUInY

protected

m_los

LOSTriStateEnum* TSLTerrainViewShedData::m_los

protected

m_losOriginX

int TSLTerrainViewShedData::m_losOriginX

protected

m_losOriginY

int TSLTerrainViewShedData::m_losOriginY

protected

m_numColumns

int TSLTerrainViewShedData::m_numColumns

protected

m_numRows

int TSLTerrainViewShedData::m_numRows

protected