Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_2::DiscreteColorMap Class Referencefinal

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

#include <DiscreteColorMap.h>

Inheritance diagram for resqml2_2::DiscreteColorMap:
resqml2::DiscreteColorMap resqml2::AbstractColorMap common::AbstractObject

Public Member Functions

 DiscreteColorMap (common::DataObjectRepository *repo, std::string const &guid, std::string const &title)
 Constructor. More...
 
 DiscreteColorMap (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 DiscreteColorMap (gsoap_eml2_3::resqml22__DiscreteColorMap *fromGsoap)
 
 ~DiscreteColorMap ()=default
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::DiscreteColorMap
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)
 https://en.wikipedia.org/wiki/HSV_color_space More...
 
unsigned int getColorCount () const
 Gets color count. More...
 
virtual std::string getXmlTag () const
 
- 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::DataObjectRepositorygetRepository () const
 
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::ActivitygetActivity (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_NS
 
- Static Public Attributes inherited from resqml2::DiscreteColorMap
static const char * 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 discrete colors. This class cannot be inherited.

Constructor & Destructor Documentation

◆ DiscreteColorMap() [1/3]

resqml2_2::DiscreteColorMap::DiscreteColorMap ( common::DataObjectRepository repo,
std::string const &  guid,
std::string const &  title 
)

Constructor.

Parameters
[in]repoIf non-nullptr, the repo.
guidThe guid to set to graphical information set.
titleA title for graphical information set.

◆ DiscreteColorMap() [2/3]

resqml2_2::DiscreteColorMap::DiscreteColorMap ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

◆ DiscreteColorMap() [3/3]

resqml2_2::DiscreteColorMap::DiscreteColorMap ( gsoap_eml2_3::resqml22__DiscreteColorMap *  fromGsoap)
inline

Creates an instance of this class by wrapping a gsoap instance.

◆ ~DiscreteColorMap()

resqml2_2::DiscreteColorMap::~DiscreteColorMap ( )
virtualdefault

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

Reimplemented from resqml2::DiscreteColorMap.

Member Function Documentation

◆ getXmlNamespace()

std::string resqml2_2::DiscreteColorMap::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::DiscreteColorMap::XML_NS
static

The standard XML namespace for serializing this data object.


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