te::ws::ogc::WCSClient Class Reference

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

#include <WCSClient.h>

Public Member Functions

te::ws::ogc::wcs::CoverageDescription describeCoverage (const std::string coverage)
 Method to get the information about a coverage in the WCS server. More...
 
const te::ws::ogc::wcs::CapabilitiesgetCapabilities () const
 Return the m_capabilities member. More...
 
std::string getCoverage (const te::ws::ogc::wcs::CoverageRequest coverageRequest, te::common::TaskProgress *taskProgress=0) const
 Method to get the coverage from the WCS server. More...
 
std::string makeFileRequest (const std::string url, const std::string fileName, te::common::TaskProgress *taskProgress=0) const
 Executes a request on a WCS server. More...
 
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 WCS server and store in m_capabilities member. More...
 
 WCSClient (const std::string usrDataDir="", const std::string uri="", const std::string version="2.0.1")
 Class constructor. It initializes the m_uri and m_version class members. More...
 
 ~WCSClient ()
 Default destructor. More...
 

Private Member Functions

std::string getFileExtension (const std::string &format) const
 

Private Attributes

te::ws::ogc::wcs::Capabilities m_capabilities
 
std::shared_ptr< te::ws::core::CurlWrapperm_curl
 
std::string m_dataDir
 
std::map< std::string, te::ws::ogc::wcs::CoverageDescriptionm_descriptionMap
 
te::ws::ogc::wcs::XMLParser m_parser
 
te::core::URI m_uri
 
std::string m_version
 

Detailed Description

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

Definition at line 61 of file WCSClient.h.

Constructor & Destructor Documentation

te::ws::ogc::WCSClient::WCSClient ( const std::string  usrDataDir = "",
const std::string  uri = "",
const std::string  version = "2.0.1" 
)

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

Parameters
usrDataDirDirectory to store used temporary XML and images from WCS server.
uriThe adress of WCS server.
versionThe WCS version.
te::ws::ogc::WCSClient::~WCSClient ( )

Default destructor.

Member Function Documentation

te::ws::ogc::wcs::CoverageDescription te::ws::ogc::WCSClient::describeCoverage ( const std::string  coverage)

Method to get the information about a coverage in the WCS server.

Parameters
coverageThe name of the coverage to describe
Returns
Return the information of the coverage in the WCS
const te::ws::ogc::wcs::Capabilities& te::ws::ogc::WCSClient::getCapabilities ( ) const

Return the m_capabilities member.

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

Returns
Returns a path to a file
std::string te::ws::ogc::WCSClient::getCoverage ( const te::ws::ogc::wcs::CoverageRequest  coverageRequest,
te::common::TaskProgress taskProgress = 0 
) const

Method to get the coverage from the WCS server.

Parameters
coverageThe struct with the desire coverage parameters
Returns
Returns a DataSet that contains the coverage
std::string te::ws::ogc::WCSClient::getFileExtension ( const std::string &  format) const
private
std::string te::ws::ogc::WCSClient::makeFileRequest ( const std::string  url,
const std::string  fileName,
te::common::TaskProgress taskProgress = 0 
) const

Executes a request on a WCS server.

Parameters
urlThe complete url of request
Returns
Returns a path to a file
void te::ws::ogc::WCSClient::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
curlWrapperWrapper to be used.
void te::ws::ogc::WCSClient::updateCapabilities ( )

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

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

Member Data Documentation

te::ws::ogc::wcs::Capabilities te::ws::ogc::WCSClient::m_capabilities
private

Definition at line 141 of file WCSClient.h.

std::shared_ptr<te::ws::core::CurlWrapper> te::ws::ogc::WCSClient::m_curl
private

Definition at line 142 of file WCSClient.h.

std::string te::ws::ogc::WCSClient::m_dataDir
private

Definition at line 139 of file WCSClient.h.

std::map<std::string, te::ws::ogc::wcs::CoverageDescription> te::ws::ogc::WCSClient::m_descriptionMap
private

Definition at line 143 of file WCSClient.h.

te::ws::ogc::wcs::XMLParser te::ws::ogc::WCSClient::m_parser
private

Definition at line 144 of file WCSClient.h.

te::core::URI te::ws::ogc::WCSClient::m_uri
private

Definition at line 140 of file WCSClient.h.

std::string te::ws::ogc::WCSClient::m_version
private

Definition at line 138 of file WCSClient.h.


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