TSLViewShedDataLayer::Observer Struct Reference

Detailed Description

An Observer encapsulates the parameters necessary to perform a viewshed operation.

Multiple Observers may be added to the datalayer. Each Observer within the layer will result in a viewshed calculation being performed and displayed by the data layer.

Public Member Functions
	Observer ()
	Constructor.
	Observer (const TSLMUCoord &position, double startHeight, bool startHeightRelativeToGround, double maxRadius)
	Constructor.
	Observer (const Observer &other)
	Copy constructor.
	~Observer ()
	Destructor.
Observer &	operator= (const Observer &other)
	Assignment operator.
bool	operator== (const Observer &other) const
	Equality operator.
const char *	name ()
void	name (const char *str)
TSLMUCoord &	position ()
void	position (const TSLMUCoord &p)
double	startHeight () const
void	startHeight (double height)
bool	startHeightRelativeToGround () const
void	startHeightRelativeToGround (bool relative)
double	endHeight () const
void	endHeight (double height)
bool	endHeightRelativeToGround () const
void	endHeightRelativeToGround (bool relative)
double	minRadius () const
void	minRadius (double radius)
double	maxRadius () const
void	maxRadius (double radius)

Constructor & Destructor Documentation

Observer() [1/3]

TSLViewShedDataLayer::Observer::Observer

(

)

Constructor.

Observer() [2/3]

TSLViewShedDataLayer::Observer::Observer	(	const TSLMUCoord &	position,
		double	startHeight,
		bool	startHeightRelativeToGround,
		double	maxRadius )

Constructor.

Observer() [3/3]

TSLViewShedDataLayer::Observer::Observer

(

const Observer &

other

)

Copy constructor.

~Observer()

TSLViewShedDataLayer::Observer::~Observer

(

)

Destructor.

Member Function Documentation

endHeight() [1/2]

double TSLViewShedDataLayer::Observer::endHeight

(

)

const

Get the end height of the Observer.

By default viewshed calculations will check which points on the ground can be seen from the Observer's position.

If the end height is set the calculation will check whether a point above the ground can be seen from the Observer's position such as the top of a mast or an aircraft.

If endHeightRelativeToGround is true then this height is relative to the ground (at each point within the viewshed calculation). Otherwise this height is relative to zero in the input data (usually sea level).

The default value of this parameter is zero.

Returns

The end height of the Observer.

endHeight() [2/2]

void TSLViewShedDataLayer::Observer::endHeight

(

double

height

)

Set the end height of the Observer.

Parameters

height

The end height of the Observer.

endHeightRelativeToGround() [1/2]

bool TSLViewShedDataLayer::Observer::endHeightRelativeToGround

(

)

const

Get whether the end height is relative to the ground.

The default value of this parameter is true.

Returns

true if endHeight is relative to the ground, false otherwise.

endHeightRelativeToGround() [2/2]

void TSLViewShedDataLayer::Observer::endHeightRelativeToGround

(

bool

relative

)

Set whether the end height is relative to the ground.

Parameters

relative

Whether endHeight is relative to the ground (At each point within the viewshed calculation).

maxRadius() [1/2]

double TSLViewShedDataLayer::Observer::maxRadius

(

)

const

Get the maximum radius of the Observer.

This sets the maximum range of the viewshed calculation for this Observer. Any points beyond this distance will not be included in the calculation.

Returns

The maximum radius of the Observer in Map Units.

maxRadius() [2/2]

void TSLViewShedDataLayer::Observer::maxRadius

(

double

radius

)

Set the maximum radius of the Observer.

Parameters

radius

The maximum radius of the Observer in Map Units.

minRadius() [1/2]

double TSLViewShedDataLayer::Observer::minRadius

(

)

const

Get the minimum radius of the Observer.

Points which are closer to the Observer than this distance will be ignored in the viewshed calculation.

The default value of this parameter is zero i.e there is no minimum radius set.

Returns

The minimum radius of the Observer in Map Units.

minRadius() [2/2]

void TSLViewShedDataLayer::Observer::minRadius

(

double

radius

)

Set the minimum radius of the Observer.

Parameters

radius

The minimum radius of the Observer in Map Units.

name() [1/2]

const char * TSLViewShedDataLayer::Observer::name

(

)

Get the name of the Observer.

This is used for information purposes only and has no effect on the viewshed calculation.

Returns

The name of the Observer.

name() [2/2]

void TSLViewShedDataLayer::Observer::name

(

const char *

str

)

Set the name of the Observer.

This is used for information purposes only and has no effect on the viewshed calculation.

Parameters

str	The name of the Observer.

operator=()

Observer & TSLViewShedDataLayer::Observer::operator=

(

const Observer &

other

)

Assignment operator.

operator==()

bool TSLViewShedDataLayer::Observer::operator==

(

const Observer &

other

)

const

Equality operator.

position() [1/2]

TSLMUCoord & TSLViewShedDataLayer::Observer::position

(

)

The position of the Observer.

Returns

The position of the Observer in Map units. This object may be modified.

position() [2/2]

void TSLViewShedDataLayer::Observer::position

(

const TSLMUCoord &

p

)

Set the position of the Observer.

Parameters

p	The position of the Observer in Map Units

startHeight() [1/2]

double TSLViewShedDataLayer::Observer::startHeight

(

)

const

Get the height of the Observer.

The units of this value are defined by the input data. Usually this is metres.

If startHeightRelativeToGround is true then this height is relative to the ground level at position. Otherwise this height is relative to zero in the input data (usually sea level).

Returns

The height of the Observer.

startHeight() [2/2]

void TSLViewShedDataLayer::Observer::startHeight

(

double

height

)

Set the height of the Observer.

Parameters

height

The height of the Observer.

startHeightRelativeToGround() [1/2]

bool TSLViewShedDataLayer::Observer::startHeightRelativeToGround

(

)

const

Get whether startHeight is relative to the ground.

Returns

true if startHeight is relative to the ground, false otherwise.

startHeightRelativeToGround() [2/2]

void TSLViewShedDataLayer::Observer::startHeightRelativeToGround

(

bool

relative

)

Set whether startHeight is relative to the ground.

Parameters

relative

Whether startHeight is relative to the ground at position.