A set of input parameters for 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 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 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. The operation is synchronous, meaning that a response will not be returned 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://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with:

http://<hostname/ipAddress>: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.

Definition at line 47 of file visualize_video.h.

Constructor & Destructor Documentation

gpudb::VisualizeVideoRequest::VisualizeVideoRequest ( )

inline

Constructs a VisualizeVideoRequest object with default parameter values.

Definition at line 54 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). gpudb::visualize_video_EPSG_4326 gpudb::visualize_video_PLATE_CARREE gpudb::visualize_video_900913 gpudb::visualize_video_EPSG_900913 gpudb::visualize_video_102100 gpudb::visualize_video_EPSG_102100 gpudb::visualize_video_3857 gpudb::visualize_video_EPSG_3857 gpudb::visualize_video_WEB_MERCATOR
[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. gpudb::visualize_video_do_points: Rasterize point data toggle. gpudb::visualize_video_true gpudb::visualize_video_false gpudb::visualize_video_do_shapes: Rasterize shapes toggle. gpudb::visualize_video_true gpudb::visualize_video_false gpudb::visualize_video_do_tracks: Rasterize tracks toggle. gpudb::visualize_video_true gpudb::visualize_video_false gpudb::visualize_video_pointcolors: RGB color value in hex for the points. gpudb::visualize_video_pointsizes: Size of points. gpudb::visualize_video_pointshapes: Shape of the point. gpudb::visualize_video_none gpudb::visualize_video_circle gpudb::visualize_video_square gpudb::visualize_video_diamond gpudb::visualize_video_hollowcircle gpudb::visualize_video_hollowsquare gpudb::visualize_video_hollowdiamond gpudb::visualize_video_SYMBOLCODE gpudb::visualize_video_shapelinewidths: Width of the lines. gpudb::visualize_video_shapelinecolors: RGB color values in hex for the line. gpudb::visualize_video_shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill. gpudb::visualize_video_tracklinewidths: Width of the track lines. '0' implies do not draw track lines. gpudb::visualize_video_tracklinecolors: RGB color values for the track lines. gpudb::visualize_video_trackmarkersizes: Size of the track point markers. gpudb::visualize_video_trackmarkercolors: Color of the track point markers. gpudb::visualize_video_trackmarkershapes: Shape of track point markers. gpudb::visualize_video_none gpudb::visualize_video_circle gpudb::visualize_video_square gpudb::visualize_video_diamond gpudb::visualize_video_hollowcircle gpudb::visualize_video_hollowsquare gpudb::visualize_video_hollowdiamond gpudb::visualize_video_SYMBOLCODE gpudb::visualize_video_trackheadcolors: Color of track head markers. gpudb::visualize_video_trackheadsizes: Size of track head markers. gpudb::visualize_video_trackheadshapes: Shape of track head markers. gpudb::visualize_video_none gpudb::visualize_video_circle gpudb::visualize_video_square gpudb::visualize_video_diamond gpudb::visualize_video_hollowcircle gpudb::visualize_video_hollowsquare gpudb::visualize_video_hollowdiamond gpudb::visualize_video_SYMBOLCODE
[in]	options_	Optional parameters.

Definition at line 240 of file visualize_video.h.

Member Data Documentation

int64_t gpudb::VisualizeVideoRequest::bgColor

Definition at line 274 of file visualize_video.h.

int32_t gpudb::VisualizeVideoRequest::height

Definition at line 272 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::maxX

Definition at line 268 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::maxY

Definition at line 270 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::minX

Definition at line 267 of file visualize_video.h.

double gpudb::VisualizeVideoRequest::minY

Definition at line 269 of file visualize_video.h.

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

Definition at line 279 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::projection

Definition at line 273 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::sessionKey

Definition at line 277 of file visualize_video.h.

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

Definition at line 278 of file visualize_video.h.

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

Definition at line 262 of file visualize_video.h.

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

Definition at line 275 of file visualize_video.h.

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

Definition at line 264 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::videoStyle

Definition at line 276 of file visualize_video.h.

int32_t gpudb::VisualizeVideoRequest::width

Definition at line 271 of file visualize_video.h.

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

Definition at line 263 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::xColumnName

Definition at line 265 of file visualize_video.h.

std::string gpudb::VisualizeVideoRequest::yColumnName

Definition at line 266 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