Map of abstract colors. More...

#include <AbstractColorMap.h>

Inheritance diagram for resqml2::AbstractColorMap:

Public Member Functions
virtual void	setHsvColors (unsigned int colorCount, double const hsvColors, double const alphas=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >(), double const *indices=nullptr)=0

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

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

virtual unsigned int	getColorCount () const =0
	Gets color count. More...

double	getHue (double colorIndex) const

double	getSaturation (double colorIndex) const

double	getValue (double colorIndex) const

double	getAlpha (double colorIndex) const

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

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

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

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

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

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

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int 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

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 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 ( double colorIndex ) const

Parameters

colorIndex index of a color in the color map. It is cast to unsigned int in the case of a discrete color map

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

◆ getColorCount()

virtual unsigned int resqml2::AbstractColorMap::getColorCount ( ) const

pure virtual

Gets color count.

Returns: The color count.

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

◆ getColorTitle()

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

Gets color title.

Parameters

colorIndex Zero-based index of the color.

Returns: The color title.

◆ getHue()

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

Parameters

colorIndex index of a color in the color map. It is cast to unsigned int in the case of a discrete color map

Returns: hue in the range [0, 360]

◆ getRgbColor() [1/2]

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

Parameters

colorIndex	index of a color in the color map. It is cast to unsigned int in the case of a discrete 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	(	double	colorIndex,
		unsigned int &	red,
		unsigned int &	green,
		unsigned int &	blue
	)		const

Parameters

colorIndex	index of a color in the color map. It is cast to unsigned int in the case of a discrete 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]

◆ getSaturation()

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

Parameters

colorIndex index of a color in the color map. It is cast to unsigned int in the case of a discrete color map

Returns: saturation in the range [0, 1]

◆ getValue()

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

Parameters

colorIndex index of a color in the color map. It is cast to unsigned int in the case of a discrete color map

Returns: value in the range [0, 1]

◆ hasColorTitle()

bool resqml2::AbstractColorMap::hasColorTitle ( double 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	(	unsigned int	colorCount,
		double const *	hsvColors,
		double const *	alphas = `nullptr`,
		std::vector< std::string > const &	colorTitles = `std::vector< std::string >()`,
		double const *	indices = `nullptr`
	)

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.
colorTitles	vector (of size colorCount) of color titles. Titles are not set if colorTitles == nullptr (default value)
indices	array (of size solorCount) 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

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

◆ setRgbColors() [1/2]

void resqml2::AbstractColorMap::setRgbColors	(	unsigned int	colorCount,
		double const *	rgbColors,
		double const *	alphas = `nullptr`,
		std::vector< std::string > const &	colorTitles = `std::vector< std::string >()`,
		double const *	indices = `nullptr`
	)

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 componant, 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, 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.
colorTitles	vector (of size colorCount) of color titles. Titles are not set if colorTitles == nullptr (default value)
indices	array (of size solorCount) 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

◆ setRgbColors() [2/2]

void resqml2::AbstractColorMap::setRgbColors	(	unsigned int	colorCount,
		unsigned int const *	rgbColors,
		double const *	alphas = `nullptr`,
		std::vector< std::string > const &	colorTitles = `std::vector< std::string >()`,
		double const *	indices = `nullptr`
	)

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 componant, 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.
colorTitles	vector (of size colorCount) of color titles. Titles are not set if colorTitles == nullptr (default value)
indices	array (of size solorCount) 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

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2/AbstractColorMap.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAlpha()

◆ getColorCount()

◆ getColorTitle()

◆ getHue()

◆ getRgbColor() [1/2]

◆ getRgbColor() [2/2]

◆ getSaturation()

◆ getValue()

◆ hasColorTitle()

◆ loadTargetRelationships()

◆ setHsvColors()

◆ setRgbColors() [1/2]

◆ setRgbColors() [2/2]