QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
QgsGraphBuilderInterface Class Reference

Determine interface for creating a graph. More...

#include <qgsgraphbuilderintr.h>

Inheritance diagram for QgsGraphBuilderInterface:
Inheritance graph
[legend]
Collaboration diagram for QgsGraphBuilderInterface:
Collaboration graph
[legend]

Public Member Functions

 QgsGraphBuilderInterface (const QgsCoordinateReferenceSystem &crs, bool ctfEnabled=true, double topologyTolerance=0.0, const QString &ellipsoidID="WGS84")
 QgsGraphBuilderInterface constructor. More...
 
virtual ~QgsGraphBuilderInterface ()
 Destructor. More...
 
QgsCoordinateReferenceSystemdestinationCrs ()
 get destinaltion Crs More...
 
bool coordinateTransformationEnabled ()
 get coordinate transformation enabled More...
 
double topologyTolerance ()
 get topology tolerance More...
 
QgsDistanceAreadistanceArea ()
 get measurement tool More...
 
virtual void addVertex (int id, const QgsPoint &pt)
 add vertex More...
 
virtual void addArc (int pt1id, const QgsPoint &pt1, int pt2id, const QgsPoint &pt2, const QVector< QVariant > &properties)
 add arc More...
 

Private Attributes

QgsCoordinateReferenceSystem mCrs
 
QgsDistanceArea mDa
 
bool mCtfEnabled
 
double mTopologyTolerance
 

Detailed Description

Determine interface for creating a graph.

Contains the settings of the graph. QgsGraphBuilder and QgsGraphDirector is a Builder pattern

Definition at line 34 of file qgsgraphbuilderintr.h.

Constructor & Destructor Documentation

QgsGraphBuilderInterface::QgsGraphBuilderInterface ( const QgsCoordinateReferenceSystem crs,
bool  ctfEnabled = true,
double  topologyTolerance = 0.0,
const QString &  ellipsoidID = "WGS84" 
)
inline

QgsGraphBuilderInterface constructor.

Parameters
crsCoordinate reference system for new graph vertex
ctfEnabledenable coordinate transform from source graph CRS to CRS graph
topologyTolerancesqrt distance between source point as one graph vertex
ellipsoidIDellipsoid for edge measurement

Definition at line 44 of file qgsgraphbuilderintr.h.

virtual QgsGraphBuilderInterface::~QgsGraphBuilderInterface ( )
inlinevirtual

Destructor.

Definition at line 53 of file qgsgraphbuilderintr.h.

Member Function Documentation

virtual void QgsGraphBuilderInterface::addArc ( int  pt1id,
const QgsPoint pt1,
int  pt2id,
const QgsPoint pt2,
const QVector< QVariant > &  properties 
)
inlinevirtual

add arc

Parameters
pt1idfirst vertex identificator
pt1first vertex coordinate
pt2idsecond vertex identificator
pt2second vertex coordinate
propertiesarc properties
Note
pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators.

Reimplemented in QgsGraphBuilder.

Definition at line 101 of file qgsgraphbuilderintr.h.

Referenced by QgsLineVectorLayerDirector::makeGraph().

virtual void QgsGraphBuilderInterface::addVertex ( int  id,
const QgsPoint pt 
)
inlinevirtual

add vertex

Parameters
idvertex identifier
ptvertex coordinate
Note
id and pt are redundant. You can use pt or id to identify the vertex

Reimplemented in QgsGraphBuilder.

Definition at line 86 of file qgsgraphbuilderintr.h.

Referenced by QgsLineVectorLayerDirector::makeGraph().

bool QgsGraphBuilderInterface::coordinateTransformationEnabled ( )
inline

get coordinate transformation enabled

Definition at line 63 of file qgsgraphbuilderintr.h.

Referenced by QgsLineVectorLayerDirector::makeGraph().

QgsCoordinateReferenceSystem& QgsGraphBuilderInterface::destinationCrs ( )
inline

get destinaltion Crs

Definition at line 57 of file qgsgraphbuilderintr.h.

Referenced by QgsLineVectorLayerDirector::makeGraph().

QgsDistanceArea* QgsGraphBuilderInterface::distanceArea ( )
inline

get measurement tool

Definition at line 75 of file qgsgraphbuilderintr.h.

Referenced by QgsLineVectorLayerDirector::makeGraph().

double QgsGraphBuilderInterface::topologyTolerance ( )
inline

get topology tolerance

Definition at line 69 of file qgsgraphbuilderintr.h.

Referenced by QgsLineVectorLayerDirector::makeGraph().

Member Data Documentation

QgsCoordinateReferenceSystem QgsGraphBuilderInterface::mCrs
private

Definition at line 111 of file qgsgraphbuilderintr.h.

bool QgsGraphBuilderInterface::mCtfEnabled
private

Definition at line 115 of file qgsgraphbuilderintr.h.

QgsDistanceArea QgsGraphBuilderInterface::mDa
private

Definition at line 113 of file qgsgraphbuilderintr.h.

double QgsGraphBuilderInterface::mTopologyTolerance
private

Definition at line 117 of file qgsgraphbuilderintr.h.


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