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
eml2_3::GraphicalInformationSet Class Reference

Proxy class for handling the graphical information of data objects. More...

#include <GraphicalInformationSet.h>

Inheritance diagram for eml2_3::GraphicalInformationSet:
eml2::GraphicalInformationSet common::AbstractObject

Public Member Functions

 GraphicalInformationSet (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 GraphicalInformationSet (common::DataObjectRepository *repo, std::string const &guid, std::string const &title)
 
 GraphicalInformationSet (gsoap_eml2_3::_eml23__GraphicalInformationSet *fromGsoap)
 
 ~GraphicalInformationSet ()=default
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from eml2::GraphicalInformationSet
unsigned int getGraphicalInformationSetCount () const
 
gsoap_eml2_3::eml23__DataObjectReference * getTargetObjectDor (unsigned int index) const
 
std::string getTargetObjectUuid (unsigned int index) const
 
AbstractObject * getTargetObject (unsigned int index) const
 
bool hasDirectGraphicalInformation (common::AbstractObject const *targetObject) const
 
bool hasGraphicalInformation (common::AbstractObject const *targetObject) const
 
bool hasDefaultColor (common::AbstractObject const *targetObject) const
 
double getDefaultHue (common::AbstractObject const *targetObject) const
 
double getDefaultSaturation (common::AbstractObject const *targetObject) const
 
double getDefaultValue (common::AbstractObject const *targetObject) const
 
double getDefaultAlpha (common::AbstractObject const *targetObject) const
 
void getDefaultRgbColor (common::AbstractObject const *targetObject, double &red, double &green, double &blue) const
 
void getDefaultRgbColor (common::AbstractObject const *targetObject, unsigned int &red, unsigned int &green, unsigned int &blue) const
 
bool hasDefaultColorTitle (common::AbstractObject const *targetObject) const
 
std::string getDefaultColorTitle (common::AbstractObject const *targetObject) const
 
void setDefaultHsvColor (common::AbstractObject *targetObject, double hue, double saturation, double value, double alpha=1.0, std::string const &colorTitle="")
 
void setDefaultRgbColor (common::AbstractObject *targetObject, double red, double green, double blue, double alpha=1.0, std::string const &colorTitle="")
 
void setDefaultRgbColor (common::AbstractObject *targetObject, unsigned int red, unsigned int green, unsigned int blue, double alpha=1.0, std::string const &colorTitle="")
 
bool hasDiscreteColorMap (common::AbstractObject const *targetObject) const
 
gsoap_eml2_3::eml23__DataObjectReference * getDiscreteColorMapDor (common::AbstractObject const *targetObject) const
 
std::string getDiscreteColorMapUuid (common::AbstractObject const *targetObject) const
 
resqml2::DiscreteColorMapgetDiscreteColorMap (common::AbstractObject const *targetObject) const
 
void setDiscreteColorMap (common::AbstractObject *targetObject, resqml2::DiscreteColorMap *discreteColorMap, bool useReverseMapping=false, bool useLogarithmicMapping=false)
 
bool hasContinuousColorMap (common::AbstractObject const *targetObject) const
 
gsoap_eml2_3::eml23__DataObjectReference * getContinuousColorMapDor (common::AbstractObject const *targetObject) const
 
std::string getContinuousColorMapUuid (common::AbstractObject const *targetObject) const
 
resqml2::ContinuousColorMapgetContinuousColorMap (common::AbstractObject const *targetObject) const
 
void setContinuousColorMap (common::AbstractObject *targetObject, resqml2::ContinuousColorMap *continuousColorMap, bool useReverseMapping=false, bool useLogarithmicMapping=false)
 
bool hasColorMapMinMax (common::AbstractObject const *targetObject) const
 
double getColorMapMin (common::AbstractObject const *targetObject) const
 
double getColorMapMax (common::AbstractObject const *targetObject) const
 
void setColorMapMinMax (common::AbstractObject const *targetObject, double min, double max) const
 
bool hasValueVectorIndex (common::AbstractObject const *targetObject)
 
int64_t getValueVectorIndex (common::AbstractObject const *targetObject)
 
void setValueVectorIndex (common::AbstractObject const *targetObject, int64_t valueVectorIndex)
 
std::string getXmlTag () 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)
 
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 eml2::GraphicalInformationSet
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 eml2::GraphicalInformationSet
static void rgbToHsv (double red, double green, double blue, double &hue, double &saturation, double &value)
 
static void rgbToHsv (unsigned int red, unsigned int green, unsigned int blue, double &hue, double &saturation, double &value)
 
static void hsvToRgb (double hue, double saturation, double value, double &red, double &green, double &blue)
 
static void hsvToRgb (double hue, double saturation, double value, unsigned int &red, unsigned int &green, unsigned int &blue)
 
- 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

Proxy class for handling the graphical information of data objects.

Constructor & Destructor Documentation

◆ GraphicalInformationSet() [1/3]

eml2_3::GraphicalInformationSet::GraphicalInformationSet ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Constructor. Only to be used in partial transfer context

Parameters
[in]partialObjectIf non-null, the partial object.

◆ GraphicalInformationSet() [2/3]

eml2_3::GraphicalInformationSet::GraphicalInformationSet ( common::DataObjectRepository repo,
std::string const &  guid,
std::string const &  title 
)

Creates a graphical information set.

Exceptions
std::invalid_argumentIf repo is null.
Parameters
[in,out]repoThe repository where the underlying gSOAP proxy is going to be created.
guidThe guid to set to graphical information set. If empty then a new guid will be generated.
titleA title for graphical information set. If empty then "unknown" title will be set.

◆ GraphicalInformationSet() [3/3]

eml2_3::GraphicalInformationSet::GraphicalInformationSet ( gsoap_eml2_3::_eml23__GraphicalInformationSet *  fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ ~GraphicalInformationSet()

eml2_3::GraphicalInformationSet::~GraphicalInformationSet ( )
virtualdefault

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

Reimplemented from eml2::GraphicalInformationSet.

Member Function Documentation

◆ getXmlNamespace()

std::string eml2_3::GraphicalInformationSet::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Reimplemented from eml2::GraphicalInformationSet.

Member Data Documentation

◆ XML_NS

const char* eml2_3::GraphicalInformationSet::XML_NS
static

The standard XML namespace for serializing this data object.


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