gpudb::InsertSymbolRequest Struct Reference

A set of input parameters for insertSymbol(const InsertSymbolRequest&) const. More...

#include <gpudb/protocol/insert_symbol.h>

Public Member Functions
	InsertSymbolRequest ()
	Constructs an InsertSymbolRequest object with default parameter values. 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
std::string	symbolFormat
std::vector< uint8_t >	symbolData
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for insertSymbol(const InsertSymbolRequest&) const.

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 or visualizeImage(const VisualizeImageRequest&) const) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Definition at line 27 of file insert_symbol.h.

Constructor & Destructor Documentation

gpudb::InsertSymbolRequest::InsertSymbolRequest ( )

inline

Constructs an InsertSymbolRequest object with default parameter values.

Definition at line 34 of file insert_symbol.h.

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'. Values: 'svg', '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. 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. Default value is an empty std::map.

Definition at line 71 of file insert_symbol.h.

Member Data Documentation

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

Definition at line 82 of file insert_symbol.h.

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

Definition at line 81 of file insert_symbol.h.

std::string gpudb::InsertSymbolRequest::symbolFormat

Definition at line 80 of file insert_symbol.h.

std::string gpudb::InsertSymbolRequest::symbolId

Definition at line 79 of file insert_symbol.h.

---

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

• gpudb/protocol/insert_symbol.h