Map of discrete colors. This class cannot be inherited. More...

#include <DiscreteColorMap.h>

Inheritance diagram for resqml2::DiscreteColorMap:

Public Member Functions
virtual	~DiscreteColorMap ()=default

void	setHsvColors (uint64_t colorCount, double const hsvColors, double const alphas=nullptr, double const *indices=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >()) final
	https://en.wikipedia.org/wiki/HSV_color_space

uint64_t	getColorCount () const final
	Gets color count.

int64_t	getColorLocationInColorMap (uint64_t colorIndex) const
	Gets the location of a color of the color map.

virtual std::string	getXmlTag () const

Public Member Functions inherited from resqml2::AbstractColorMap
void	setRgbColors (uint64_t colorCount, double const rgbColors, double const alphas=nullptr, double const *indices=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >())

void	setRgbColors (uint64_t colorCount, uint8_t const rgbColors, double const alphas=nullptr, double const *indices=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >())

double	getHue (uint64_t colorIndex) const

double	getSaturation (uint64_t colorIndex) const

double	getValue (uint64_t colorIndex) const

double	getAlpha (uint64_t colorIndex) const

void	getRgbColor (uint64_t colorIndex, double &red, double &green, double &blue) const

void	getRgbColor (uint64_t colorIndex, uint8_t &red, uint8_t &green, uint8_t &blue) const

bool	hasColorTitle (uint64_t colorIndex) const
	Queries if 'colorIndex' has color title.

std::string	getColorTitle (uint64_t colorIndex) const
	Gets color title.

void	setNullHsvColor (double hue, double saturation, double value, double alpha=1, std::string const &colorTitle="")
	Sets the NullColor value of a continuous color map.

void	setNullRgbColor (double red, double green, double blue, double alpha=1, std::string const &colorTitle="")
	Sets the NullColor value of a continuous color map.

void	setNullRgbColor (uint8_t red, uint8_t green, uint8_t blue, double alpha=1, std::string const &colorTitle="")
	Sets the NullColor value of a continuous color map.

bool	hasNullColor () const
	checks if the color map has a definition for the color of Null values.

double	getNullHue () const

double	getNullSaturation () const

double	getNullValue () const

double	getNullAlpha () const

void	getNullRgbColor (double &red, double &green, double &blue) const

void	getNullRgbColor (uint8_t &red, uint8_t &green, uint8_t &blue) const

void	loadTargetRelationships ()

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const =0

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

uint64_t	getAliasCount () const

std::string	getAliasAuthorityAtIndex (uint64_t index) const

std::string	getAliasTitleAtIndex (uint64_t index) const

std::vector< eml2::Activity * >	getActivitySet () const

uint64_t	getActivityCount () const

eml2::Activity *	getActivity (uint64_t index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

Static Public Attributes
static constexpr char const *	XML_TAG = "DiscreteColorMap"

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

Detailed Description

Map of discrete colors. This class cannot be inherited.

Constructor & Destructor Documentation

◆ ~DiscreteColorMap()

virtual resqml2::DiscreteColorMap::~DiscreteColorMap ( )

virtualdefault

Destructor does nothing since the memory is managed by the gsoap context.

Reimplemented in resqml2_2::DiscreteColorMap.

Member Function Documentation

◆ getColorCount()

uint64_t resqml2::DiscreteColorMap::getColorCount ( ) const

finalvirtual

Gets color count.

Returns: The color count.

Implements resqml2::AbstractColorMap.

◆ getColorLocationInColorMap()

int64_t resqml2::DiscreteColorMap::getColorLocationInColorMap ( uint64_t colorIndex ) const

Gets the location of a color of the color map.

Parameters

colorIndex Zero-based index of the color.

Returns: The color location in the color map.

◆ getXmlTag()

virtual std::string resqml2::DiscreteColorMap::getXmlTag ( ) const

inlinevirtual

Get the standard XML tag without XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ setHsvColors()

void resqml2::DiscreteColorMap::setHsvColors	(	uint64_t	colorCount,
		double const *	hsvColors,
		double const *	alphas = nullptr,
		double const *	indices = nullptr,
		std::vector< std::string > const &	colorTitles = std::vector< std::string >() )

finalvirtual

https://en.wikipedia.org/wiki/HSV_color_space

Parameters

colorCount	the size (number of colors) of the discrete color map.
hsvColors	array (of size colorCount * 3) of HSV colors with hsvColors[3i] is the hue, hsvColors[3i + 1] is the saturation and hsvColors[3*i + 2] is the value of the ith color (hue is in range [0, 360] while saturation and value are in range [0, 1])
alphas	(Optional) array (of size colorCount) of numeric values in the range [0, 1] for alpha transparency channel (0 means transparent and 1 means opaque). If alphas == nullptr (default value), default alpha value is 1.
indices	(Optional) array (of size colorCount) of color indices. These indices are cast to unsigned int in the case of a discrete color map. If indices == nullptr (default value), indices are set from 0 to colorCount - 1.
colorTitles	(Optional) vector (of size colorCount) of color titles. Titles are not set if colorTitles is empty (default value)

Implements resqml2::AbstractColorMap.

Member Data Documentation

◆ XML_TAG

char const* resqml2::DiscreteColorMap::XML_TAG = "DiscreteColorMap"

staticconstexpr

The standard XML tag without XML namespace for serializing this data object.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2/DiscreteColorMap.h

Public Member Functions

Static Public Attributes

Additional Inherited Members