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

#include <ContinuousColorMap.h>

Inheritance diagram for resqml2::ContinuousColorMap:

Public Member Functions
virtual	~ContinuousColorMap ()=default

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)

unsigned int	getColorCount () const
	Gets color count. More...

gsoap_eml2_3::resqml22__InterpolationDomain	getInterpolationDomain ()
	Gets interpolation domain. More...

std::string	getInterpolationDomainAsString ()
	Gets interpolation domain as string. More...

gsoap_eml2_3::resqml22__InterpolationMethod	getInterpolationMethod ()
	Gets interpolation method. More...

std::string	getInterpolationMethodAsString ()
	Gets interpolation method as string. More...

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

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

void	setNanRgbColor (unsigned int red, unsigned int green, unsigned int blue, double alpha=1, std::string const &colorTitle="")
	Sets the NanColor value of a continuous color map. More...

std::string	getXmlTag () const
	Gets XML tag. More...

Public Member Functions inherited from resqml2::AbstractColorMap
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)

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	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

Static Public Attributes
static const char *	XML_TAG
	The XML tag.

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 continuous colors. This class cannot be inherited.

Constructor & Destructor Documentation

◆ ~ContinuousColorMap()

virtual resqml2::ContinuousColorMap::~ContinuousColorMap ( )

virtualdefault

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

Reimplemented in resqml2_2::ContinuousColorMap.

Member Function Documentation

◆ getColorCount()

unsigned int resqml2::ContinuousColorMap::getColorCount ( ) const

virtual

Gets color count.

Returns: The color count.

Implements resqml2::AbstractColorMap.

◆ getInterpolationDomain()

gsoap_eml2_3::resqml22__InterpolationDomain resqml2::ContinuousColorMap::getInterpolationDomain ( )

Gets interpolation domain.

Returns: The interpolation domain.

◆ getInterpolationDomainAsString()

std::string resqml2::ContinuousColorMap::getInterpolationDomainAsString ( )

Gets interpolation domain as string.

Returns: The interpolation domain as string.

◆ getInterpolationMethod()

gsoap_eml2_3::resqml22__InterpolationMethod resqml2::ContinuousColorMap::getInterpolationMethod ( )

Gets interpolation method.

Returns: The interpolation method.

◆ getInterpolationMethodAsString()

std::string resqml2::ContinuousColorMap::getInterpolationMethodAsString ( )

Gets interpolation method as string.

Returns: The interpolation method as string.

◆ getXmlTag()

std::string resqml2::ContinuousColorMap::getXmlTag ( ) const

inlinevirtual

Gets XML tag.

Returns: The XML tag.

Implements common::AbstractObject.

◆ setHsvColors()

void resqml2::ContinuousColorMap::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`
	)

virtual

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

Parameters

colorCount	the size (number of colors) of the continuous 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. If indices == nullptr (default value), indices are set from 0 to colorCount - 1

Implements resqml2::AbstractColorMap.

◆ setNanHsvColor()

void resqml2::ContinuousColorMap::setNanHsvColor	(	double	hue,
		double	saturation,
		double	value,
		double	alpha = `1`,
		std::string const &	colorTitle = `""`
	)

Sets the NanColor 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)

◆ setNanRgbColor() [1/2]

void resqml2::ContinuousColorMap::setNanRgbColor	(	double	red,
		double	green,
		double	blue,
		double	alpha = `1`,
		std::string const &	colorTitle = `""`
	)

Sets the NanColor 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)

◆ setNanRgbColor() [2/2]

void resqml2::ContinuousColorMap::setNanRgbColor	(	unsigned int	red,
		unsigned int	green,
		unsigned int	blue,
		double	alpha = `1`,
		std::string const &	colorTitle = `""`
	)

Sets the NanColor 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)

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ContinuousColorMap()

Member Function Documentation

◆ getColorCount()

◆ getInterpolationDomain()

◆ getInterpolationDomainAsString()

◆ getInterpolationMethod()

◆ getInterpolationMethodAsString()

◆ getXmlTag()

◆ setHsvColors()

◆ setNanHsvColor()

◆ setNanRgbColor() [1/2]

◆ setNanRgbColor() [2/2]