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

#include <gpudb/protocol/create_video.h>

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

	CreateVideoRequest (const std::string &attribute_, const std::string &begin_, const double durationSeconds_, const std::string &end_, const double framesPerSecond_, const std::string &style_, const std::string &path_, const std::string &styleParameters_, const std::map< std::string, std::string > &options_)
	Constructs a CreateVideoRequest object with the specified parameters. More...

Public Attributes
std::string	attribute

std::string	begin

double	durationSeconds

std::string	end

double	framesPerSecond

std::string	style

std::string	path

std::string	styleParameters

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

Detailed Description

A set of input parameters for const.

Creates a job to generate a sequence of raster images that visualize data over a specified time.

Definition at line 19 of file create_video.h.

Constructor & Destructor Documentation

gpudb::CreateVideoRequest::CreateVideoRequest ( )

inline

Constructs a CreateVideoRequest object with default parameter values.

Definition at line 26 of file create_video.h.

gpudb::CreateVideoRequest::CreateVideoRequest	(	const std::string &	attribute_,
		const std::string &	begin_,
		const double	durationSeconds_,
		const std::string &	end_,
		const double	framesPerSecond_,
		const std::string &	style_,
		const std::string &	path_,
		const std::string &	styleParameters_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateVideoRequest object with the specified parameters.

Parameters

[in]	attribute_	The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.
[in]	begin_	The start point for the video. Accepts an expression evaluable over the attribute.
[in]	durationSeconds_	Seconds of video to produce
[in]	end_	The end point for the video. Accepts an expression evaluable over the attribute.
[in]	framesPerSecond_	The presentation frame rate of the encoded video in frames per second.
[in]	style_	The name of the visualize mode; should correspond to the schema used for the styleParameters field. gpudb::create_video_chart gpudb::create_video_raster gpudb::create_video_classbreak gpudb::create_video_contour gpudb::create_video_heatmap gpudb::create_video_labels
[in]	path_	Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
[in]	styleParameters_	A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
[in]	options_	Optional parameters. gpudb::create_video_ttl: Sets the TTL of the video. gpudb::create_video_window: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data. gpudb::create_video_no_error_if_exists: If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. gpudb::create_video_false gpudb::create_video_true The default value is gpudb::create_video_false. gpudb::create_video_replace_if_exists: If true, deletes any existing video with the same path before creating a new video. gpudb::create_video_false gpudb::create_video_true The default value is gpudb::create_video_false.

Definition at line 114 of file create_video.h.

Member Data Documentation

std::string gpudb::CreateVideoRequest::attribute

Definition at line 127 of file create_video.h.

std::string gpudb::CreateVideoRequest::begin

Definition at line 128 of file create_video.h.

double gpudb::CreateVideoRequest::durationSeconds

Definition at line 129 of file create_video.h.

std::string gpudb::CreateVideoRequest::end

Definition at line 130 of file create_video.h.

double gpudb::CreateVideoRequest::framesPerSecond

Definition at line 131 of file create_video.h.

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

Definition at line 135 of file create_video.h.

std::string gpudb::CreateVideoRequest::path

Definition at line 133 of file create_video.h.

std::string gpudb::CreateVideoRequest::style

Definition at line 132 of file create_video.h.

std::string gpudb::CreateVideoRequest::styleParameters

Definition at line 134 of file create_video.h.

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

gpudb/protocol/create_video.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation