A set of parameters for GPUdb::insertSymbol. More...

#include <gpudb/protocol/insert_symbol.h>

Public Member Functions
	InsertSymbolRequest ()
	Constructs an InsertSymbolRequest object with default parameters. More...

	InsertSymbolRequest (const std::string &symbolId_, const std::string &symbolFormat_, const std::vector< uint8_t > &symbolData_, const std::map< std::string, std::string > &options_)
	Constructs an InsertSymbolRequest object with the specified parameters. More...

Public Attributes
std::string	symbolId
	The id of the symbol being added. More...

std::string	symbolFormat
	Specifies the symbol format. More...

std::vector< uint8_t >	symbolData
	The actual symbol data. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::insertSymbol.

Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Definition at line 27 of file insert_symbol.h.

Constructor & Destructor Documentation

◆ InsertSymbolRequest() [1/2]

gpudb::InsertSymbolRequest::InsertSymbolRequest ( )

inline

Constructs an InsertSymbolRequest object with default parameters.

Definition at line 32 of file insert_symbol.h.

◆ InsertSymbolRequest() [2/2]

gpudb::InsertSymbolRequest::InsertSymbolRequest	(	const std::string &	symbolId_,
		const std::string &	symbolFormat_,
		const std::vector< uint8_t > &	symbolData_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an InsertSymbolRequest object with the specified parameters.

Parameters

[in]	symbolId_	The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
[in]	symbolFormat_	Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values: insert_symbol_svg insert_symbol_svg_path
[in]	symbolData_	The actual symbol data. If symbolFormat_ is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat_ is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'
[in]	options_	Optional parameters. insert_symbol_color: If symbolFormat_ is 'svg' this is ignored. If symbolFormat_ is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default. The default value is an empty map.

Definition at line 77 of file insert_symbol.h.

Member Data Documentation

◆ options

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

Optional parameters.

insert_symbol_color: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.

The default value is an empty map.

Definition at line 121 of file insert_symbol.h.

◆ symbolData

std::vector<uint8_t> gpudb::InsertSymbolRequest::symbolData

The actual symbol data.

If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'

Definition at line 107 of file insert_symbol.h.

◆ symbolFormat

std::string gpudb::InsertSymbolRequest::symbolFormat

Specifies the symbol format.

Must be either 'svg' or 'svg_path'. Supported values:

Definition at line 99 of file insert_symbol.h.

◆ symbolId

std::string gpudb::InsertSymbolRequest::symbolId

The id of the symbol being added.

This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol

Definition at line 89 of file insert_symbol.h.

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

gpudb/protocol/insert_symbol.h

Public Member Functions

Public Attributes