A class to retrieve information and data from a Web Map Service. More...

#include <WMSClient.h>

Public Member Functions
const te::ws::ogc::wms::WMSCapabilities &	getCapabilities () const
	Return the WMSCapabilities member. More...

const te::ws::ogc::wms::WMSGetFeatureInfoResponse	getFeatureInfo (const te::ws::ogc::wms::WMSGetFeatureInfoRequest &request) const
	It execute a WMS GetFeatureInfo and returns a WMSGetFeatureInfoResponse with the result. More...

const te::ws::ogc::wms::WMSGetMapResponse	getMap (const te::ws::ogc::wms::WMSGetMapRequest &request) const
	Return the WMSGetMapResponse member. More...

bool	isAccessible ()

std::string	makeFileRequest (const std::string &url, const std::string &fileName) const
	Executes a request on a WMS server. More...

std::string	makeRequest (const std::string &url) const
	Executes a request on a WMS server. More...

const std::string	saveGetMap (const te::ws::ogc::wms::WMSGetMapRequest &request, const std::string &filename)
	It execute a WMS GetMap and save the result image on disk. The request will be based on WMSGetMapRequest setted to this WMSLayer. More...

void	setCapabilities (const te::ws::ogc::wms::WMSCapabilities &capabilities)

void	setCurlWrapper (te::ws::core::CurlWrapper *curlWrapper)
	Sets the TerraLib CurlWrapper to be used internally. More...

void	updateCapabilities ()
	Method to get the capabilities from a WMS server and store in m_capabilities member. More...

	WMSClient (const std::string &usrDataDir="", const std::string &uri="", const std::string &version="1.3.0")
	Class constructor. It initializes the m_uri and m_version class members. More...

	~WMSClient ()
	Default destructor. More...

Private Member Functions
std::string	build111GetFeatureInfoURL (const te::ws::ogc::wms::WMSGetFeatureInfoRequest &request) const

std::string	build111GetMapRequestURL (const te::ws::ogc::wms::WMSGetMapRequest &request) const

std::string	build130GetFeatureInfoURL (const te::ws::ogc::wms::WMSGetFeatureInfoRequest &request) const

std::string	build130GetMapRequestURL (const te::ws::ogc::wms::WMSGetMapRequest &request) const

std::string	buildGetFeatureInfoURL (const te::ws::ogc::wms::WMSGetFeatureInfoRequest &request) const

std::string	buildGetMapRequestURL (const te::ws::ogc::wms::WMSGetMapRequest &request) const

Private Attributes
te::ws::ogc::wms::WMSCapabilities	m_capabilities

std::shared_ptr< te::ws::core::CurlWrapper >	m_curl

std::string	m_dataDir

std::unique_ptr< te::ws::ogc::wms::XMLParser >	m_parser

te::core::URI	m_uri

std::string	m_version

Detailed Description

A class to retrieve information and data from a Web Map Service.

Definition at line 57 of file WMSClient.h.

Constructor & Destructor Documentation

◆ WMSClient()

te::ws::ogc::WMSClient::WMSClient	(	const std::string &	usrDataDir = `""`,
		const std::string &	uri = `""`,
		const std::string &	version = `"1.3.0"`
	)

Class constructor. It initializes the m_uri and m_version class members.

Parameters

usrDataDir	Directory to store used temporary XML and images from WMS server.
uri	The adress of WMS server.
version	The WMS version.

◆ ~WMSClient()

te::ws::ogc::WMSClient::~WMSClient ( )

Default destructor.

Member Function Documentation

◆ build111GetFeatureInfoURL()

std::string te::ws::ogc::WMSClient::build111GetFeatureInfoURL ( const te::ws::ogc::wms::WMSGetFeatureInfoRequest & request ) const

private

◆ build111GetMapRequestURL()

std::string te::ws::ogc::WMSClient::build111GetMapRequestURL ( const te::ws::ogc::wms::WMSGetMapRequest & request ) const

private

◆ build130GetFeatureInfoURL()

std::string te::ws::ogc::WMSClient::build130GetFeatureInfoURL ( const te::ws::ogc::wms::WMSGetFeatureInfoRequest & request ) const

private

◆ build130GetMapRequestURL()

std::string te::ws::ogc::WMSClient::build130GetMapRequestURL ( const te::ws::ogc::wms::WMSGetMapRequest & request ) const

private

◆ buildGetFeatureInfoURL()

std::string te::ws::ogc::WMSClient::buildGetFeatureInfoURL ( const te::ws::ogc::wms::WMSGetFeatureInfoRequest & request ) const

private

◆ buildGetMapRequestURL()

std::string te::ws::ogc::WMSClient::buildGetMapRequestURL ( const te::ws::ogc::wms::WMSGetMapRequest & request ) const

private

◆ getCapabilities()

const te::ws::ogc::wms::WMSCapabilities& te::ws::ogc::WMSClient::getCapabilities ( ) const

Return the WMSCapabilities member.

   The WMSCapabilities will be empty until the updateCapabilities() method its called.

Returns: Returns the WMSCapabilities member.

◆ getFeatureInfo()

const te::ws::ogc::wms::WMSGetFeatureInfoResponse te::ws::ogc::WMSClient::getFeatureInfo ( const te::ws::ogc::wms::WMSGetFeatureInfoRequest & request ) const

It execute a WMS GetFeatureInfo and returns a WMSGetFeatureInfoResponse with the result.

Returns: a WMSGetFeatureInfoResponse with server response.

◆ getMap()

const te::ws::ogc::wms::WMSGetMapResponse te::ws::ogc::WMSClient::getMap ( const te::ws::ogc::wms::WMSGetMapRequest & request ) const

Return the WMSGetMapResponse member.

   Make the GetMapRequest and return the server answer as a WMSGetMapResponse.

Returns: Returns a path to a file

◆ isAccessible()

bool te::ws::ogc::WMSClient::isAccessible ( )

◆ makeFileRequest()

std::string te::ws::ogc::WMSClient::makeFileRequest	(	const std::string &	url,
		const std::string &	fileName
	)		const

Executes a request on a WMS server.

Parameters

url	The complete url of request

Returns: Returns a path to a file

◆ makeRequest()

std::string te::ws::ogc::WMSClient::makeRequest ( const std::string & url ) const

Executes a request on a WMS server.

Parameters

url	The complete url of request

Returns: Returns the buffer with the content of the server response

◆ saveGetMap()

const std::string te::ws::ogc::WMSClient::saveGetMap	(	const te::ws::ogc::wms::WMSGetMapRequest &	request,
		const std::string &	filename
	)

It execute a WMS GetMap and save the result image on disk. The request will be based on WMSGetMapRequest setted to this WMSLayer.

Returns: std::string with saved image path.

◆ setCapabilities()

void te::ws::ogc::WMSClient::setCapabilities ( const te::ws::ogc::wms::WMSCapabilities & capabilities )

◆ setCurlWrapper()

void te::ws::ogc::WMSClient::setCurlWrapper ( te::ws::core::CurlWrapper * curlWrapper )

Sets the TerraLib CurlWrapper to be used internally.

   By default it is an instance of te::ws::core::CurlWrapper class.

Parameters

curlWrapper Wrapper to be used. Checks if we have access to the current URI

◆ updateCapabilities()

void te::ws::ogc::WMSClient::updateCapabilities ( )

Method to get the capabilities from a WMS server and store in m_capabilities member.

   To access the information contained in the m_capabilities, use the getCapabilities() method.

Member Data Documentation

◆ m_capabilities

te::ws::ogc::wms::WMSCapabilities te::ws::ogc::WMSClient::m_capabilities

private

Definition at line 167 of file WMSClient.h.

◆ m_curl

std::shared_ptr<te::ws::core::CurlWrapper> te::ws::ogc::WMSClient::m_curl

private

Definition at line 168 of file WMSClient.h.

◆ m_dataDir

std::string te::ws::ogc::WMSClient::m_dataDir

private

Definition at line 165 of file WMSClient.h.

◆ m_parser

std::unique_ptr<te::ws::ogc::wms::XMLParser> te::ws::ogc::WMSClient::m_parser

private

Definition at line 169 of file WMSClient.h.

◆ m_uri

te::core::URI te::ws::ogc::WMSClient::m_uri

private

Definition at line 166 of file WMSClient.h.

◆ m_version

std::string te::ws::ogc::WMSClient::m_version

private

Definition at line 164 of file WMSClient.h.

The documentation for this class was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/ws/ogc/wms/client/WMSClient.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WMSClient()

◆ ~WMSClient()

Member Function Documentation

◆ build111GetFeatureInfoURL()

◆ build111GetMapRequestURL()

◆ build130GetFeatureInfoURL()

◆ build130GetMapRequestURL()

◆ buildGetFeatureInfoURL()

◆ buildGetMapRequestURL()

◆ getCapabilities()

◆ getFeatureInfo()

◆ getMap()

◆ isAccessible()

◆ makeFileRequest()

◆ makeRequest()

◆ saveGetMap()

◆ setCapabilities()

◆ setCurlWrapper()

◆ updateCapabilities()

Member Data Documentation

◆ m_capabilities

◆ m_curl

◆ m_dataDir

◆ m_parser

◆ m_uri

◆ m_version