Skip to content
Permalink
Browse files
Added documentation and QgsServer to doxy template
  • Loading branch information
elpaso authored and m-kuhn committed May 30, 2015
1 parent d5b2e7b commit 0f8f6188b0def1b60ce885a3c8b51c8e627cdca5
Showing with 35 additions and 3 deletions.
  1. +1 −0 cmake_templates/Doxyfile.in
  2. +0 −1 src/server/qgsserverfilter.h
  3. +27 −2 src/server/qgsserverinterface.h
  4. +7 −0 src/server/qgsserverplugins.h
@@ -596,6 +596,7 @@ INPUT = @CMAKE_SOURCE_DIR@/doc \
@CMAKE_SOURCE_DIR@/src/analysis/raster \
@CMAKE_SOURCE_DIR@/src/analysis/vector \
@CMAKE_SOURCE_DIR@/src/plugins \
@CMAKE_SOURCE_DIR@/src/server/qgsserver.h \
@CMAKE_SOURCE_DIR@/src/server/qgscapabilitiescache.h \
@CMAKE_SOURCE_DIR@/src/server/qgsmapserviceexception.h \
@CMAKE_SOURCE_DIR@/src/server/qgsrequesthandler.h \
@@ -34,7 +34,6 @@ class QgsServerInterface;
* after core services have returned to main loop
* * sendResponse() - called just before sending output to FGCI
*/

class SERVER_EXPORT QgsServerFilter
{

@@ -41,14 +41,39 @@ class SERVER_EXPORT QgsServerInterface
/** Destructor */
virtual ~QgsServerInterface() = 0;

/**
* Set the request handler
* @param QgsRequestHandler
*/
virtual void setRequestHandler( QgsRequestHandler* requestHandler ) = 0;

/**
* Get pointer to the capabiblities cache
* @return QgsCapabilitiesCache
*/
virtual QgsCapabilitiesCache* capabiblitiesCache() = 0;

/**
* Get pointer to the request handler
* @return QgsRequestHandler
*/
virtual QgsRequestHandler* requestHandler( ) = 0;

/**
* Register a QgsServerFilter
* @param filter the QgsServerFilter to add
* @param priority an optional priority for the filter order
*/
virtual void registerFilter( QgsServerFilter* filter, int priority = 0 ) = 0;

/**
* Return the list of current QgsServerFilter
* @return QgsServerFiltersMap list of QgsServerFilter
*/
virtual QgsServerFiltersMap filters( ) = 0;
/*Pass environment variables to python*/
virtual QString getEnv( const QString& name ) const = 0;

//! Return an enrironment variable, used to pass environment variables to python
virtual QString getEnv( const QString& name ) const = 0;
};

#endif // QGSSERVERINTERFACE_H
@@ -26,8 +26,15 @@ class SERVER_EXPORT QgsServerPlugins
{
public:
explicit QgsServerPlugins();
/**
* Initialise the python plugins
* @param interface QgsServerInterface
* @return bool true on success
*/
static bool initPlugins( QgsServerInterface* interface );
//! Pointer to QgsPythonUtils
static QgsPythonUtils* mPythonUtils;
//! List of available server plugin names
static QStringList mServerPlugins;
};

0 comments on commit 0f8f618

Please sign in to comment.