luciad::WmsLayer Class Reference

Contains information about a layer as described in a WMS GetCapabilities response. More...

#include <luciad/formats/wms/WmsLayer.h>

Public Member Functions
	~WmsLayer ()
const std::optional< std::string > &	getAbstract () const
	Returns the layer's abstract. More...
const std::vector< std::shared_ptr< WmsLayer > > &	getChildLayers () const
	Returns the layer's children. More...
const std::vector< std::string > &	getKeywords () const
	Returns the layer's keywords. More...
const std::optional< std::string > &	getName () const
	Returns the layer's name. More...
std::vector< std::shared_ptr< WmsLayerStyle > >	getStyles (bool withInheritedStyles=false) const
	Returns the layer's styles and the inherited ones if specified. More...
const std::string &	getTitle () const
	Returns the layer's title. More...
bool	isOpaque () const
	Returns whether the layer is opaque. More...

Detailed Description

Contains information about a layer as described in a WMS GetCapabilities response.

Since

2020.2

Constructor & Destructor Documentation

~WmsLayer()

luciad::WmsLayer::~WmsLayer

(

)

Member Function Documentation

getAbstract()

const std::optional< std::string > & luciad::WmsLayer::getAbstract

(

)

const

Returns the layer's abstract.

Returns

the layer's abstract.

getChildLayers()

const std::vector< std::shared_ptr< WmsLayer > > & luciad::WmsLayer::getChildLayers

(

)

const

Returns the layer's children.

Returns an empty vector if the layer has no child.

Returns

the layer's children.

getKeywords()

const std::vector< std::string > & luciad::WmsLayer::getKeywords

(

)

const

Returns the layer's keywords.

Returns an empty vector when the layer doesn't have a keyword.

Returns

the layer's keywords. Returns an empty vector when the layer doesn't have a keyword.

getName()

const std::optional< std::string > & luciad::WmsLayer::getName

(

)

const

Returns the layer's name.

Returns

the layer's name.

getStyles()

std::vector< std::shared_ptr< WmsLayerStyle > > luciad::WmsLayer::getStyles

(

bool

withInheritedStyles = false

)

const

Returns the layer's styles and the inherited ones if specified.

Parameters

withInheritedStyles

specify if the returned style list should contain styles inherited from parent layers. default value is false.

Returns

the layer's styles and the inherited ones if specified.

getTitle()

const std::string & luciad::WmsLayer::getTitle

(

)

const

Returns the layer's title.

Returns

the layer's title.

isOpaque()

bool luciad::WmsLayer::isOpaque

(

)

const

Returns whether the layer is opaque.

Returns

whether the layer is opaque.