Map of abstract colors. More...

#include <AbstractColorMap.h>

Inheritance diagram for resqml2::AbstractColorMap:

Public Member Functions
virtual 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 >())=0
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 >())
virtual uint64_t	getColorCount () const =0
	Gets color count.
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	getXmlTag () 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
uint64_t	getExtraMetadataCount () const
std::string	getExtraMetadataKeyAtIndex (uint64_t index) const
std::string	getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string	buildEtp12Uri () const
void	setUriSource (const std::string &uriSource)
const std::string &	getUriSource () const
std::string	getEpcSourceFolder () const
void	changeToPartialObject ()
template<>
int8_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int8_t arrayOutput) const
template<>
uint8_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint8_t arrayOutput) const
template<>
int16_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int16_t arrayOutput) const
template<>
uint16_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint16_t arrayOutput) const
template<>
int32_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int32_t arrayOutput) const
template<>
uint32_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint32_t arrayOutput) const
template<>
int64_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int64_t arrayOutput) const
template<>
uint64_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint64_t arrayOutput) const
template<>
int8_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int8_t arrayOutput) const
template<>
uint8_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint8_t arrayOutput) const
template<>
int16_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int16_t arrayOutput) const
template<>
uint16_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint16_t arrayOutput) const
template<>
int32_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int32_t arrayOutput) const
template<>
uint32_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint32_t arrayOutput) const
template<>
int64_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int64_t arrayOutput) const
template<>
uint64_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint64_t arrayOutput) const

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 abstract colors.

Member Function Documentation

◆ getAlpha()

double resqml2::AbstractColorMap::getAlpha ( uint64_t colorIndex ) const

Parameters

colorIndex index of a color in the color map.

Returns: alpha in the range [0, 1] (0 means transparent and 1 means opaque)

◆ getColorCount()

virtual uint64_t resqml2::AbstractColorMap::getColorCount ( ) const

pure virtual

Gets color count.

Returns: The color count.

Implemented in resqml2::ContinuousColorMap, and resqml2::DiscreteColorMap.

◆ getColorTitle()

std::string resqml2::AbstractColorMap::getColorTitle ( uint64_t colorIndex ) const

Gets color title.

Parameters

colorIndex Zero-based index of the color.

Returns: The color title.

◆ getHue()

double resqml2::AbstractColorMap::getHue ( uint64_t colorIndex ) const

Parameters

colorIndex index of a color in the color map.

Returns: hue in the range [0, 360]

◆ getNullAlpha()

double resqml2::AbstractColorMap::getNullAlpha ( ) const

Returns: alpha in the range [0, 1] (0 means transparent and 1 means opaque)

◆ getNullHue()

double resqml2::AbstractColorMap::getNullHue ( ) const

Returns: hue in the range [0, 360]

◆ getNullRgbColor() [1/2]

void resqml2::AbstractColorMap::getNullRgbColor	(	double &	red,
		double &	green,
		double &	blue ) const

Parameters

red	(output parameter) red value in the range [0, 1]
green	(output parameter) green value in the range [0, 1]
blue	(output parameter) blue value in the range [0, 1]

◆ getNullRgbColor() [2/2]

void resqml2::AbstractColorMap::getNullRgbColor	(	uint8_t &	red,
		uint8_t &	green,
		uint8_t &	blue ) const

Parameters

red	(output parameter) red value in the range [0, 255]
green	(output parameter) green value in the range [0, 255]
blue	(output parameter) blue value in the range [0, 255]

◆ getNullSaturation()

double resqml2::AbstractColorMap::getNullSaturation ( ) const

Returns: saturation in the range [0, 1]

◆ getNullValue()

double resqml2::AbstractColorMap::getNullValue ( ) const

Returns: value in the range [0, 1]

◆ getRgbColor() [1/2]

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

Parameters

colorIndex	index of a color in the color map.
red	(output parameter) red value in the range [0, 1]
green	(output parameter) green value in the range [0, 1]
blue	(output parameter) blue value in the range [0, 1]

◆ getRgbColor() [2/2]

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

Parameters

colorIndex	index of a color in the color map.
red	(output parameter) red value in the range [0, 255]
green	(output parameter) green value in the range [0, 255]
blue	(output parameter) blue value in the range [0, 255]

◆ getSaturation()

double resqml2::AbstractColorMap::getSaturation ( uint64_t colorIndex ) const

Parameters

colorIndex index of a color in the color map.

Returns: saturation in the range [0, 1]

◆ getValue()

double resqml2::AbstractColorMap::getValue ( uint64_t colorIndex ) const

Parameters

colorIndex index of a color in the color map.

Returns: value in the range [0, 1]

◆ hasColorTitle()

bool resqml2::AbstractColorMap::hasColorTitle ( uint64_t colorIndex ) const

Queries if 'colorIndex' has color title.

Parameters

colorIndex Zero-based index of the color.

Returns: True if color title, false if not.

◆ loadTargetRelationships()

void resqml2::AbstractColorMap::loadTargetRelationships ( )

inlinevirtual

Reads the forward relationships of this data object and update the .rels of the associated data repository.

Implements common::AbstractObject.

◆ setHsvColors()

virtual void resqml2::AbstractColorMap::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 >() )

pure virtual

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

Parameters

colorCount	the size (number of colors) of the 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	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	array (of size colorCount) of color indices. These indices are cast to unsigned int in the case of a discrete color map. If indices
colorTitles	vector (of size colorCount) of color titles. Titles are not set if colorTitles is empty (default value)= nullptr (default value), indices are set from 0 to colorCount - 1

Implemented in resqml2::ContinuousColorMap, and resqml2::DiscreteColorMap.

◆ setNullHsvColor()

void resqml2::AbstractColorMap::setNullHsvColor	(	double	hue,
		double	saturation,
		double	value,
		double	alpha = 1,
		std::string const &	colorTitle = "" )

Sets the NullColor value of a continuous color map.

Parameters

hue	hue in the range [0, 360].
saturation	saturation in the range [0, 1].
value	value in the range [0, 1].
alpha	(Optional) alpha in the range [0, 1] (0 means transparent and 1 means opaque). Default alpha value is 1.
colorTitle	(Optional) color title. It is not set if empty string (default value)

◆ setNullRgbColor() [1/2]

void resqml2::AbstractColorMap::setNullRgbColor	(	double	red,
		double	green,
		double	blue,
		double	alpha = 1,
		std::string const &	colorTitle = "" )

Sets the NullColor value of a continuous color map.

Parameters

red	red value in the range [0, 1].
green	green value in the range [0, 1].
blue	blue value in the range [0, 1].
alpha	(Optional) alpha in the range [0, 1] (0 means transparent and 1 means opaque). Default alpha value is 1.
colorTitle	(Optional) color title. It is not set if empty string (default value)

◆ setNullRgbColor() [2/2]

void resqml2::AbstractColorMap::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.

Parameters

red	red value in the range [0, 255].
green	green value in the range [0, 255].
blue	blue value in the range [0, 255].
alpha	(Optional) alpha in the range [0, 1] (0 means transparent and 1 means opaque). Default alpha value is 1.
colorTitle	(Optional) color title. It is not set if empty string (default value)

◆ setRgbColors() [1/2]

void resqml2::AbstractColorMap::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 >() )

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

Parameters

colorCount	the size (number of colors) of the color map
rgbColors	array (of size colorCount * 3) of RGB colors with rgbColors[3i] is red component, rgbColors[3i + 1] is green component and rgbColors[3*i + 2] is blue component of the ith color (red, green and blue are in range [0, 1])
alphas	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	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	vector (of size colorCount) of color titles. Titles are not set if colorTitles is empty (default value)

◆ setRgbColors() [2/2]

void resqml2::AbstractColorMap::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 >() )

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

Parameters

colorCount	the size (number of colors) of the color map
rgbColors	array (of size colorCount * 3) of RGB colors with hsvColors[3i] is red component, hsvColors[3i + 1] is green component and hsvColors[3*i + 2] is blue component of the ith color (red, green and blue are in range [0, 255])
alphas	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	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	vector (of size colorCount) of color titles. Titles are not set if colorTitles is empty (default value)

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

C:/Users/phili/dev/fesapi/fesapi-2.14.0.0/src/resqml2/AbstractColorMap.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAlpha()

◆ getColorCount()

◆ getColorTitle()

◆ getHue()

◆ getNullAlpha()

◆ getNullHue()

◆ getNullRgbColor() [1/2]

◆ getNullRgbColor() [2/2]

◆ getNullSaturation()

◆ getNullValue()

◆ getRgbColor() [1/2]

◆ getRgbColor() [2/2]

◆ getSaturation()

◆ getValue()

◆ hasColorTitle()

◆ loadTargetRelationships()

◆ setHsvColors()

◆ setNullHsvColor()

◆ setNullRgbColor() [1/2]

◆ setNullRgbColor() [2/2]

◆ setRgbColors() [1/2]

◆ setRgbColors() [2/2]