QGIS/python/analysis/auto_generated/network/qgsnetworkstrategy.sip.in

66 lines
2.3 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/network/qgsnetworkstrategy.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
%ModuleHeaderCode
#include <qgsnetworkspeedstrategy.h>
#include <qgsnetworkdistancestrategy.h>
%End
class QgsNetworkStrategy
{
2021-03-22 21:13:52 +01:00
%Docstring(signature="appended")
:py:class:`QgsNetworkStrategy` defines strategy used for calculation of the edge cost. For example it can
2017-12-15 10:36:55 -04:00
take into account travel distance, amount of time or money. Currently there are two strategies
implemented in the analysis library: :py:class:`QgsNetworkDistanceStrategy` and :py:class:`QgsNetworkSpeedStrategy`.
:py:class:`QgsNetworkStrategy` implemented using "strategy" design pattern.
%End
%TypeHeaderCode
#include "qgsnetworkstrategy.h"
%End
%ConvertToSubClassCode
if ( dynamic_cast< QgsNetworkDistanceStrategy * >( sipCpp ) != NULL )
sipType = sipType_QgsNetworkDistanceStrategy;
else if ( dynamic_cast< QgsNetworkSpeedStrategy * >( sipCpp ) != NULL )
sipType = sipType_QgsNetworkSpeedStrategy;
else
sipType = NULL;
%End
public:
QgsNetworkStrategy();
%Docstring
2017-12-15 10:36:55 -04:00
Default constructor
%End
virtual ~QgsNetworkStrategy();
2017-10-29 08:43:47 +10:00
virtual QSet< int > requiredAttributes() const;
%Docstring
2017-12-15 10:36:55 -04:00
Returns a list of the source layer attributes needed for cost calculation.
2017-12-19 11:43:52 -04:00
This is method called by :py:class:`QgsGraphDirector`.
%End
virtual QVariant cost( double distance, const QgsFeature &f ) const = 0;
%Docstring
2017-12-15 10:36:55 -04:00
Returns edge cost
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/network/qgsnetworkstrategy.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/