luciad::LonLatGridLayer Class Reference

Longitude Latitude (LonLat) grid layer that can be added to a map. More...

#include <luciad/layers/grids/lonlat/LonLatGridLayer.h>

Inheritance diagram for luciad::LonLatGridLayer:

Classes
class	Builder
	Builder for creating a LonLatGridLayer. More...

Public Member Functions
	~LonLatGridLayer () override
void	addObserver (std::shared_ptr< ILayerObserver > layerObserver) override
	Adds an observer that allows to receive change events from this layer. More...
const std::string &	getTitle () const override
	Returns the layer's title. More...
bool	isLabeled () const override
	Returns whether this layer displays labels. More...
bool	isVisible () const override
	Returns whether this layer is visible. More...
void	removeObserver (const std::shared_ptr< ILayerObserver > &layerObserver) override
	Removes the given observer. More...
void	setLabeled (bool labeled) override
	Sets whether this layer displays labels. More...
void	setTitle (std::string title) override
	Sets the layer's title. More...
void	setVisible (bool visible) override
	Sets whether this layer is visible. More...
virtual bool	isLabeled () const =0
	Returns whether this layer displays labels. More...
virtual void	setLabeled (bool labeled)=0
	Sets whether this layer displays labels. More...
Public Member Functions inherited from luciad::Layer
	Layer ()
	Default constructor. More...
virtual	~Layer ()=default
virtual void	addObserver (std::shared_ptr< ILayerObserver > layerObserver)=0
	Adds an observer that allows to receive change events from this layer. More...
virtual LayerId	getId () const
	Returns the layer's unique id. More...
virtual const std::string &	getTitle () const =0
	Returns the layer's title. More...
virtual bool	isVisible () const =0
	Returns whether this layer is visible. More...
virtual void	removeObserver (const std::shared_ptr< ILayerObserver > &layerObserver)=0
	Removes the given observer. More...
virtual void	setTitle (std::string title)=0
	Sets the layer's title. More...
virtual void	setVisible (bool visible)=0
	Sets whether this layer is visible. More...

Static Public Member Functions
static Builder	newBuilder ()
	Returns a new builder for creating a LonLatGridLayer. More...
Static Public Member Functions inherited from luciad::GridLayer
static const std::string &	propertyLabeled ()
	Property name for the LayerEvent that is fired as a result of changing the layer's labeled flag. More...
Static Public Member Functions inherited from luciad::Layer
static const std::string &	propertyTitle ()
	Property name for the LayerEvent that is fired as a result of changing the layer's title. More...
static const std::string &	propertyVisible ()
	Property name for the LayerEvent that is fired as a result of changing the layer's visible flag. More...

Additional Inherited Members
Protected Member Functions inherited from luciad::GridLayer
	GridLayer ()
	Default constructor. More...

Detailed Description

Longitude Latitude (LonLat) grid layer that can be added to a map.

Since

2023.1

Constructor & Destructor Documentation

~LonLatGridLayer()

luciad::LonLatGridLayer::~LonLatGridLayer ( )

override

Member Function Documentation

addObserver()

void luciad::LonLatGridLayer::addObserver ( std::shared_ptr< ILayerObserver >  layerObserver )

overridevirtual

Adds an observer that allows to receive change events from this layer.

Adding the same observer twice is forbidden, and will cause an exception to be thrown.

Parameters

layerObserver

an observer.

Exceptions

luciad::InvalidArgumentException	when the observer was already added.
luciad::NullArgumentException	when the observer is nullptr.

Implements luciad::Layer.

getTitle()

const std::string & luciad::LonLatGridLayer::getTitle ( ) const

overridevirtual

Returns the layer's title.

Should be suitable for presenting to the user.

Returns

the layer's title, should be suitable for presenting to the user.

Implements luciad::Layer.

isLabeled()

bool luciad::LonLatGridLayer::isLabeled ( ) const

overridevirtual

Returns whether this layer displays labels.

Returns

whether this layer displays labels.

Implements luciad::GridLayer.

isVisible()

bool luciad::LonLatGridLayer::isVisible ( ) const

overridevirtual

Returns whether this layer is visible.

Returns

whether this layer is visible.

Implements luciad::Layer.

newBuilder()

static Builder luciad::LonLatGridLayer::newBuilder ( )

static

Returns a new builder for creating a LonLatGridLayer.

Returns

a new builder for creating a LonLatGridLayer.

removeObserver()

void luciad::LonLatGridLayer::removeObserver ( const std::shared_ptr< ILayerObserver > &  layerObserver )

overridevirtual

Removes the given observer.

If the given observer was never added, an exception is thrown.

Parameters

layerObserver

an observer.

Exceptions

luciad::InvalidArgumentException	when the observer is not known.
luciad::NullArgumentException	when the observer is nullptr.

Implements luciad::Layer.

setLabeled()

void luciad::LonLatGridLayer::setLabeled ( bool  labeled )

overridevirtual

Sets whether this layer displays labels.

Parameters

labeled

true to enable labels.

Implements luciad::GridLayer.

setTitle()

void luciad::LonLatGridLayer::setTitle ( std::string  title )

overridevirtual

Sets the layer's title.

Should be suitable for presenting to the user.

If the new title is indeed different from the old one, a LayerEvent is delivered to the observers with the property name PropertyTitle.

Parameters

title

the new title.

Implements luciad::Layer.

setVisible()

void luciad::LonLatGridLayer::setVisible ( bool  visible )

overridevirtual

Sets whether this layer is visible.

Changes this layer's visibility. If the new visibility is different from the old one, a LayerEvent is delivered to the observers with the property name PropertyVisible.

Parameters

visible

the new visibility.

Implements luciad::Layer.