GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::VisualizeIsochroneRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/visualize_isochrone.h>

Public Member Functions

 VisualizeIsochroneRequest ()
 Constructs a VisualizeIsochroneRequest object with default parameter values. More...
 
 VisualizeIsochroneRequest (const std::string &graphName_, const std::string &sourceNode_, const double maxSolutionRadius_, const std::vector< std::string > &weightsOnEdges_, const std::vector< std::string > &restrictions_, const int32_t numLevels_, const bool generateImage_, const std::string &levelsTable_, const std::map< std::string, std::string > &styleOptions_, const std::map< std::string, std::string > &solveOptions_, const std::map< std::string, std::string > &contourOptions_, const std::map< std::string, std::string > &options_)
 Constructs a VisualizeIsochroneRequest object with the specified parameters. More...
 

Public Attributes

std::string graphName
 
std::string sourceNode
 
double maxSolutionRadius
 
std::vector< std::string > weightsOnEdges
 
std::vector< std::string > restrictions
 
int32_t numLevels
 
bool generateImage
 
std::string levelsTable
 
std::map< std::string,
std::string > 
styleOptions
 
std::map< std::string,
std::string > 
solveOptions
 
std::map< std::string,
std::string > 
contourOptions
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Network Graphs & Solvers for more information on graphs.

Definition at line 25 of file visualize_isochrone.h.

Constructor & Destructor Documentation

gpudb::VisualizeIsochroneRequest::VisualizeIsochroneRequest ( )
inline

Constructs a VisualizeIsochroneRequest object with default parameter values.

Definition at line 32 of file visualize_isochrone.h.

gpudb::VisualizeIsochroneRequest::VisualizeIsochroneRequest ( const std::string &  graphName_,
const std::string &  sourceNode_,
const double  maxSolutionRadius_,
const std::vector< std::string > &  weightsOnEdges_,
const std::vector< std::string > &  restrictions_,
const int32_t  numLevels_,
const bool  generateImage_,
const std::string &  levelsTable_,
const std::map< std::string, std::string > &  styleOptions_,
const std::map< std::string, std::string > &  solveOptions_,
const std::map< std::string, std::string > &  contourOptions_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a VisualizeIsochroneRequest object with the specified parameters.

Parameters
[in]graphName_Name of the graph on which the isochrone is to be computed.
[in]sourceNode_Starting vertex on the underlying graph from/to which the isochrones are created.
[in]maxSolutionRadius_Extent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius.
[in]weightsOnEdges_Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', or expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s).
[in]restrictions_Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', or expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED'. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED').
[in]numLevels_Number of equally-separated isochrones to compute.
[in]generateImage_If set to true, generates a PNG image of the isochrones in the response. The default value is gpudb::visualize_isochrone_true.
[in]levelsTable_Name of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated.
[in]styleOptions_Various style related options of the isochrone image.
[in]solveOptions_Solver specific parameters
[in]contourOptions_Solver specific parameters
[in]options_Additional parameters

Definition at line 537 of file visualize_isochrone.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::contourOptions

Definition at line 563 of file visualize_isochrone.h.

bool gpudb::VisualizeIsochroneRequest::generateImage

Definition at line 559 of file visualize_isochrone.h.

std::string gpudb::VisualizeIsochroneRequest::graphName

Definition at line 553 of file visualize_isochrone.h.

std::string gpudb::VisualizeIsochroneRequest::levelsTable

Definition at line 560 of file visualize_isochrone.h.

double gpudb::VisualizeIsochroneRequest::maxSolutionRadius

Definition at line 555 of file visualize_isochrone.h.

int32_t gpudb::VisualizeIsochroneRequest::numLevels

Definition at line 558 of file visualize_isochrone.h.

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::options

Definition at line 564 of file visualize_isochrone.h.

std::vector<std::string> gpudb::VisualizeIsochroneRequest::restrictions

Definition at line 557 of file visualize_isochrone.h.

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::solveOptions

Definition at line 562 of file visualize_isochrone.h.

std::string gpudb::VisualizeIsochroneRequest::sourceNode

Definition at line 554 of file visualize_isochrone.h.

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::styleOptions

Definition at line 561 of file visualize_isochrone.h.

std::vector<std::string> gpudb::VisualizeIsochroneRequest::weightsOnEdges

Definition at line 556 of file visualize_isochrone.h.


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