#include <PropertySet.h>

Inheritance diagram for resqml2_0_1::PropertySet:

Public Member Functions
	PropertySet (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	PropertySet (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, bool hasMultipleRealizations, bool hasSinglePropertyKind, gsoap_eml2_3::resqml22__TimeSetKind timeSetKind)
	Creates an instance of this class in a gsoap context. More...

	PropertySet (gsoap_resqml2_0_1::_resqml20__PropertySet *fromGsoap)

	~PropertySet ()=default

bool	hasMultipleRealizations () const final

bool	hasSinglePropertyKind () const final

gsoap_eml2_3::resqml22__TimeSetKind	getTimeSetKind () const final

std::string	getXmlNamespace () const final

Public Member Functions inherited from resqml2::PropertySet
	PropertySet (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

void	setParent (PropertySet *parent)

PropertySet *	getParent () const

std::vector< PropertySet * >	getChildren () const

unsigned int	getChildrenCount () const

PropertySet *	getChildren (unsigned int index) const

void	pushBackProperty (resqml2::AbstractProperty *prop)

std::vector< resqml2::AbstractProperty * >	getProperties () const

unsigned int	getPropertyCount () const

resqml2::AbstractProperty *	getProperty (unsigned int index) const

virtual std::string	getXmlTag () const final

void	loadTargetRelationships () final

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

Static Public Attributes inherited from resqml2::PropertySet
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

A set of properties collected together for a specific purpose. For example, a property set can be used to collect all the properties corresponding to the simulation output at a single time, or all the values of a single property kind for all times.

Constructor & Destructor Documentation

◆ PropertySet() [1/3]

resqml2_0_1::PropertySet::PropertySet ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out] partialObject If non-null, the partial object.

◆ PropertySet() [2/3]

resqml2_0_1::PropertySet::PropertySet	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		bool	hasMultipleRealizations,
		bool	hasSinglePropertyKind,
		gsoap_eml2_3::resqml22__TimeSetKind	timeSetKind
	)

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument	If `repo == nullptr`.
std::invalid_argument	If `timeSetKind` is single time series.

Parameters

[in]	repo	The DataObjectRepository where the instance must be created.
	guid	A guid for the instance to create. Empty guid lead to the creation of a random one.
	title	A title for the instance to create.
	hasMultipleRealizations	If true, indicates that the collection contains properties with defined realization indices.
	hasSinglePropertyKind	If true, indicates that the collection contains only property values associated with a single property kind.
	timeSetKind	the time set kind of this property set.

◆ PropertySet() [3/3]

resqml2_0_1::PropertySet::PropertySet ( gsoap_resqml2_0_1::_resqml20__PropertySet * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~PropertySet()

resqml2_0_1::PropertySet::~PropertySet ( )

virtualdefault

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

Reimplemented from resqml2::PropertySet.

Member Function Documentation

◆ getTimeSetKind()

gsoap_eml2_3::resqml22__TimeSetKind resqml2_0_1::PropertySet::getTimeSetKind ( ) const

finalvirtual

Gets the time set kind that applies on all properties directly contained in this property set. "Directly contained" means that the time set kind does not apply on properties contained in the children property set.

Returns: The time set kind associated to this this property set.

Implements resqml2::PropertySet.

◆ getXmlNamespace()

std::string resqml2_0_1::PropertySet::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ hasMultipleRealizations()

bool resqml2_0_1::PropertySet::hasMultipleRealizations ( ) const

finalvirtual

Checks whether this property set contains at least one property with multiple realization indices. This method just read the HasMultipleRealizations attribute value. The value of this attribute only concerns properties directly contained in this property set and thus does not inform about properties contained in the children property set.

Returns: True if this property set contains properties with multiple realization indices, false if not.

Implements resqml2::PropertySet.

◆ hasSinglePropertyKind()

bool resqml2_0_1::PropertySet::hasSinglePropertyKind ( ) const

finalvirtual

Checks whether this property set contains only property values associated with a single property kind. This method just read the HasSinglePropertyKind attribute value. The value of this attribute only concerns properties directly contained in this property set and thus does not inform about properties contained in the children property set.

Returns: True if this property set contains only property values associated with a single property kind.

Implements resqml2::PropertySet.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::PropertySet::XML_NS

static

The standard XML namespace for serializing this data object.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/resqml2_0_1/PropertySet.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PropertySet() [1/3]

◆ PropertySet() [2/3]

◆ PropertySet() [3/3]

◆ ~PropertySet()

Member Function Documentation

◆ getTimeSetKind()

◆ getXmlNamespace()

◆ hasMultipleRealizations()

◆ hasSinglePropertyKind()

Member Data Documentation

◆ XML_NS