Skip to content
Permalink
Browse files

Add more doc for WMS service

  • Loading branch information
pblottiere committed Jul 11, 2018
1 parent 67cbb27 commit 4853c62c064bd230409249737d15861f911f043c
@@ -27,35 +27,38 @@ namespace QgsWms

/**
* \ingroup server
* thiss class provides a proxy for sequential or parallel map render job by
* reading qsettings.
* \since QGIS 3.0
*/
* \class QgsWms::QgsMapRendererJobProxy
* \brief Proxy for sequential or parallel map render job by reading qsettings.
* \since QGIS 3.0
*/
class QgsMapRendererJobProxy
{
public:

/**
* Constructor.
* \param featureFilterProvider Does not take ownership of QgsFeatureFilterProvider
*/
* Constructor for QgsMapRendererJobProxy. Does not take ownership of
* QgsFeatureFilterProvider.
* \param parallelRendering True to activate parallel rendering, false otherwise
* \param maxThreads The number of threads to use in case of parallel rendering
* \param featureFilterProvider Features filtering
*/
QgsMapRendererJobProxy(
bool parallelRendering
, int maxThreads
, QgsFeatureFilterProvider *featureFilterProvider
);

/**
* Sequential or parallel map rendering according to qsettings.
* \param mapSettings passed to MapRendererJob
* \param the rendered image
*/
* Sequential or parallel map rendering according to QSettings.
* \param mapSettings Passed to MapRendererJob
* \param image The resulting image
*/
void render( const QgsMapSettings &mapSettings, QImage *image );

/**
* Take ownership of the painter used for rendering.
* \returns painter
*/
* Takes ownership of the painter used for rendering.
* \returns painter
*/
QPainter *takePainter();

private:
@@ -72,19 +72,17 @@ namespace QgsWms
QgsServerResponse &response, bool projectSettings = false );

/**
* Create WMS GetCapabilities document
*
* Returns an XML document with the capabilities description (as described in the WMS specs)
* Creates the WMS GetCapabilities XML document.
* \param serverIface Interface for plugins
* \param project Project
* \param version WMS version
* \param projectSettings If true: add extended project information (does not validate against WMS schema)
* \param request WMS request
* \param projectSettings If true, adds extended project information (does not validate against WMS schema)
* \returns GetCapabilities XML document
*/
QDomDocument getCapabilities( QgsServerInterface *serverIface, const QgsProject *project,
const QString &version, const QgsServerRequest &request, bool projectSettings );


} // samespace QgsWms

const QString &version, const QgsServerRequest &request,
bool projectSettings );
} // namespace QgsWms

#endif


0 comments on commit 4853c62

Please sign in to comment.
You can’t perform that action at this time.