GPUdb C++ API
Version 7.2.2.4
|
A set of parameters for GPUdb::visualizeIsochrone. More...
#include <gpudb/protocol/visualize_isochrone.h>
Public Member Functions | |
VisualizeIsochroneRequest () | |
Constructs a VisualizeIsochroneRequest object with default parameters. 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 |
Name of the graph on which the isochrone is to be computed. More... | |
std::string | sourceNode |
Starting vertex on the underlying graph from/to which the isochrones are created. More... | |
double | maxSolutionRadius |
Extent of the search radius around sourceNode. More... | |
std::vector< std::string > | weightsOnEdges |
Additional weights to apply to the edges of an existing graph. More... | |
std::vector< std::string > | restrictions |
Additional restrictions to apply to the nodes/edges of an existing graph. More... | |
int32_t | numLevels |
Number of equally-separated isochrones to compute. More... | |
bool | generateImage |
If set to true, generates a PNG image of the isochrones in the response. More... | |
std::string | levelsTable |
Name of the table to output the isochrones to, in [ schema_name. More... | |
std::map< std::string, std::string > | styleOptions |
Various style related options of the isochrone image. More... | |
std::map< std::string, std::string > | solveOptions |
Solver specific parameters. More... | |
std::map< std::string, std::string > | contourOptions |
Solver specific parameters. More... | |
std::map< std::string, std::string > | options |
Additional parameters. More... | |
A set of parameters for GPUdb::visualizeIsochrone.
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 Graphs & Solvers for more information on graphs.
Definition at line 23 of file visualize_isochrone.h.
|
inline |
Constructs a VisualizeIsochroneRequest object with default parameters.
Definition at line 29 of file visualize_isochrone.h.
|
inline |
Constructs a VisualizeIsochroneRequest object with the specified 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. The default value is -1.0. |
[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). The default value is an empty vector. |
[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'). The default value is an empty vector. |
[in] | numLevels_ | Number of equally-separated isochrones to compute. The default value is 1. |
[in] | generateImage_ | If set to true, generates a PNG image of the isochrones in the response. Supported values:
|
[in] | levelsTable_ | Name of the table to output the isochrones to, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ''. |
[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 779 of file visualize_isochrone.h.
std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::contourOptions |
Solver specific parameters.
The default value is an empty map.
Definition at line 1228 of file visualize_isochrone.h.
bool gpudb::VisualizeIsochroneRequest::generateImage |
If set to true, generates a PNG image of the isochrones in the response.
Supported values:
The default value is true.
Definition at line 866 of file visualize_isochrone.h.
std::string gpudb::VisualizeIsochroneRequest::graphName |
Name of the graph on which the isochrone is to be computed.
Definition at line 798 of file visualize_isochrone.h.
std::string gpudb::VisualizeIsochroneRequest::levelsTable |
Name of the table to output the isochrones to, in [ schema_name.
\ ]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ''.
Definition at line 878 of file visualize_isochrone.h.
double gpudb::VisualizeIsochroneRequest::maxSolutionRadius |
Extent of the search radius around sourceNode.
Set to '-1.0' for unrestricted search radius. The default value is -1.0.
Definition at line 810 of file visualize_isochrone.h.
int32_t gpudb::VisualizeIsochroneRequest::numLevels |
Number of equally-separated isochrones to compute.
The default value is 1.
Definition at line 854 of file visualize_isochrone.h.
std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::options |
Additional parameters.
The default value is an empty map.
Definition at line 1314 of file visualize_isochrone.h.
std::vector<std::string> gpudb::VisualizeIsochroneRequest::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'). The default value is an empty vector.
Definition at line 848 of file visualize_isochrone.h.
std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::solveOptions |
Solver specific parameters.
The default value is an empty map.
Definition at line 1102 of file visualize_isochrone.h.
std::string gpudb::VisualizeIsochroneRequest::sourceNode |
Starting vertex on the underlying graph from/to which the isochrones are created.
Definition at line 804 of file visualize_isochrone.h.
std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::styleOptions |
Various style related options of the isochrone image.
Definition at line 1067 of file visualize_isochrone.h.
std::vector<std::string> gpudb::VisualizeIsochroneRequest::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). The default value is an empty vector.
Definition at line 826 of file visualize_isochrone.h.