A set of input parameters for visualizeVideo(const VisualizeVideoRequest&) const. More...

#include <gpudb/protocol/visualize_video.h>

Public Member Functions
	VisualizeVideoRequest ()
	Constructs a VisualizeVideoRequest object with default parameter values. More...

	VisualizeVideoRequest (const std::vector< std::string > &tableNames, const std::vector< std::string > &worldTableNames, const std::vector< std::vector< std::string > > &trackIds, const std::string &xColumnName, const std::string &yColumnName, const double minX, const double maxX, const double minY, const double maxY, const int32_t width, const int32_t height, const std::string &projection, const int64_t bgColor, const std::vector< std::vector< double > > &timeIntervals, const std::string &videoStyle, const std::string &sessionKey, const std::map< std::string, std::vector< std::string > > &styleOptions, const std::map< std::string, std::string > &options)
	Constructs a VisualizeVideoRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	tableNames

std::vector< std::string >	worldTableNames

std::vector< std::vector< std::string > >	trackIds

std::string	xColumnName

std::string	yColumnName

double	minX

double	maxX

double	minY

double	maxY

int32_t	width

int32_t	height

std::string	projection

int64_t	bgColor

std::vector< std::vector< double > >	timeIntervals

std::string	videoStyle

std::string	sessionKey

std::map< std::string, std::vector< std::string > >	styleOptions

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

Detailed Description

A set of input parameters for visualizeVideo(const VisualizeVideoRequest&) const.

Creates raster images of data in the given table based on provided input parameters. Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of GPUdb table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL::

http://<gpudb-ip-address>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with::

http://gpudb-ip-address:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19 The response payload provides, among other things, the number of frames which were created by GPUdb.

Definition at line 45 of file visualize_video.h.

Constructor & Destructor Documentation

gpudb::VisualizeVideoRequest::VisualizeVideoRequest ( )

inline

Constructs a VisualizeVideoRequest object with default parameter values.

Definition at line 52 of file visualize_video.h.

gpudb::VisualizeVideoRequest::VisualizeVideoRequest	(	const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	worldTableNames,
		const std::vector< std::vector< std::string > > &	trackIds,
		const std::string &	xColumnName,
		const std::string &	yColumnName,
		const double	minX,
		const double	maxX,
		const double	minY,
		const double	maxY,
		const int32_t	width,
		const int32_t	height,
		const std::string &	projection,
		const int64_t	bgColor,
		const std::vector< std::vector< double > > &	timeIntervals,
		const std::string &	videoStyle,
		const std::string &	sessionKey,
		const std::map< std::string, std::vector< std::string > > &	styleOptions,
		const std::map< std::string, std::string > &	options
	)

inline

Constructs a VisualizeVideoRequest object with the specified parameters.

Parameters

[in]	tableNames	Names of the tables containing the data for various layers of the resulting video.
[in]	worldTableNames	Optional name of the tables containing the data for the entire track when the tableNames contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the tableNames
[in]	trackIds	Tracks from the tableNames to be rendered.
[in]	xColumnName	Name of the column containing the x coordinates.
[in]	yColumnName	Name of the column containing the y coordinates.
[in]	minX	Lower bound for the x values.
[in]	maxX	Upper bound for the x values.
[in]	minY	Lower bound for the y values.
[in]	maxY	Upper bound for the y values.
[in]	width	Width of the generated image.
[in]	height	Height of the generated image.
[in]	projection	Spatial Reference System (i.e. EPSG Code). Values: 'EPSG:4326', 'PLATE_CARREE', '900913', 'EPSG:900913', '102100', 'EPSG:102100', '3857', 'EPSG:3857', 'WEB_MERCATOR'. Default value is 'PLATE_CARREE'.
[in]	bgColor	Background color of the generated image.
[in]	timeIntervals
[in]	videoStyle
[in]	sessionKey	User Provided session key that is later used to retrieve the generated video from the WMS.
[in]	styleOptions	Styling options for the image. do_points: Rasterize point data toggle. Values: 'true', 'false'. do_shapes: Rasterize shapes toggle. Values: 'true', 'false'. do_tracks: Rasterize tracks toggle. Values: 'true', 'false'. pointcolors: RGB color value in hex for the points. pointsizes: Size of points. pointshapes: Shape of the point. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'. shapelinewidths: Width of the lines. shapelinecolors: RGB color values in hex for the line. shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill. tracklinewidths: Width of the track lines. '0' implies do not draw track lines. tracklinecolors: RGB color values for the track lines. trackmarkersizes: Size of the track point markers. trackmarkercolors: Color of the track point markers. trackmarkershapes: Shape of track point markers. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'. trackheadcolors: Color of track head markers. trackheadsizes: Size of track head markers. trackheadshapes: Shape of track head markers. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 159 of file visualize_video.h.

Member Data Documentation

int64_t gpudb::VisualizeVideoRequest::bgColor

Definition at line 193 of file visualize_video.h.

int32_t gpudb::VisualizeVideoRequest::height

Definition at line 191 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::maxX

Definition at line 187 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::maxY

Definition at line 189 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::minX

Definition at line 186 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::minY

Definition at line 188 of file visualize_video.h.

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

Definition at line 198 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::projection

Definition at line 192 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::sessionKey

Definition at line 196 of file visualize_video.h.

std::map<std::string, std::vector<std::string> > gpudb::VisualizeVideoRequest::styleOptions

Definition at line 197 of file visualize_video.h.

std::vector<std::string> gpudb::VisualizeVideoRequest::tableNames

Definition at line 181 of file visualize_video.h.

std::vector<std::vector<double> > gpudb::VisualizeVideoRequest::timeIntervals

Definition at line 194 of file visualize_video.h.

std::vector<std::vector<std::string> > gpudb::VisualizeVideoRequest::trackIds

Definition at line 183 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::videoStyle

Definition at line 195 of file visualize_video.h.

int32_t gpudb::VisualizeVideoRequest::width

Definition at line 190 of file visualize_video.h.

std::vector<std::string> gpudb::VisualizeVideoRequest::worldTableNames

Definition at line 182 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::xColumnName

Definition at line 184 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::yColumnName

Definition at line 185 of file visualize_video.h.

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

gpudb/protocol/visualize_video.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation