Proxy class for a property set. A property set is a set of properties collected together for a specific purpose. More...

#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_resqml2_0_1::resqml20__TimeSetKind timeSetKind)
	Creates an instance of this class in a gsoap context.

	PropertySet (gsoap_resqml2_0_1::_resqml20__PropertySet *fromGsoap)

	~PropertySet ()=default

void	setParent (PropertySet *parent)

common::DataObjectReference	getParentDor () const

PropertySet *	getParent () const

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

uint64_t	getChildrenCount () const noexcept

PropertySet *	getChildren (uint64_t index) const

void	pushBackProperty (resqml2::AbstractProperty *prop)

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

uint64_t	getPropertyCount () const noexcept

resqml2::AbstractProperty *	getProperty (uint64_t index) const

bool	hasMultipleRealizations () const

bool	hasSinglePropertyKind () const

gsoap_resqml2_0_1::resqml20__TimeSetKind	getTimeSetKind () const

std::string	getXmlNamespace () const final

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)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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)

uint64_t	getAliasCount () const

std::string	getAliasAuthorityAtIndex (uint64_t index) const

std::string	getAliasTitleAtIndex (uint64_t index) const

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

uint64_t	getActivityCount () const

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

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

Static Public Attributes
static constexpr char const *	XML_NS = "resqml20"

static constexpr char const *	XML_TAG = "PropertySet"

static constexpr char const *	FAKE_PROP_UUID = "6b6656bb-32c4-4c4a-84ec-f66cf50bd4dd"

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 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

Proxy class for a property set. A property set is 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_resqml2_0_1::resqml20__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 ( )

default

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

Member Function Documentation

◆ getChildren() [1/2]

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

Gets the children property set of this instance.

Returns: A vector of pointer to the children property set or empty vector if this instance has no child property set.

◆ getChildren() [2/2]

PropertySet * resqml2_0_1::PropertySet::getChildren ( uint64_t index ) const

Gets a particular child property set of this property set.

Exceptions

std::out_of_range If index is out of range.

Parameters

index Zero-based index of the child property set we look for.

Returns: The child property set at position index.

◆ getChildrenCount()

uint64_t resqml2_0_1::PropertySet::getChildrenCount ( ) const

inlinenoexcept

Gets the count of all children property set of this instance.

Returns: The children count.

◆ getParent()

PropertySet * resqml2_0_1::PropertySet::getParent ( ) const

Gets the parent property set of this instance.

Returns: A pointer to the parent property set or nullptr if no parent property set is defined.

◆ getParentDor()

common::DataObjectReference resqml2_0_1::PropertySet::getParentDor ( ) const

Gets the data object reference of the parent property set of this instance.

Returns: Empty data object reference if no parent property set is defined, else the data object reference of the parent property set.

◆ getProperties()

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

Gets all properties directly contained in this property set. "Directly contained" means that this method does not collect properties contained in the children property set.

Returns: The vector of pointer to all the contained properties.

◆ getProperty()

resqml2::AbstractProperty * resqml2_0_1::PropertySet::getProperty ( uint64_t index ) const

Gets a particular property among the properties directly contained in this property set. "Directly contained" means that this method does not look at properties contained in the children property set.

Exceptions

std::out_of_range If index is out of range.

Parameters

index Zero-based index of the property we look for.

Returns: The contained property at position index.

◆ getPropertyCount()

uint64_t resqml2_0_1::PropertySet::getPropertyCount ( ) const

noexcept

Gets the count of all properties directly contained in this property set. "Directly contained" means that this method does not count properties contained in the children property set.

Returns: The count of contained properties.

◆ getXmlNamespace()

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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

virtual std::string resqml2_0_1::PropertySet::getXmlTag ( ) const

inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ loadTargetRelationships()

void resqml2_0_1::PropertySet::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Implements common::AbstractObject.

◆ pushBackProperty()

void resqml2_0_1::PropertySet::pushBackProperty ( resqml2::AbstractProperty * prop )

Pushes back a property into this property set.

Exceptions

std::invalid_argument If prop is nullptr.

Parameters

[in] prop The property to push into this property set.

◆ setParent()

void resqml2_0_1::PropertySet::setParent ( PropertySet * parent )

Sets the parent property set of this instance.

Exceptions

std::invalid_argument If parent is nullptr.

Parameters

[in] parent The parent to set to this instance.

Member Data Documentation

◆ FAKE_PROP_UUID

char const* resqml2_0_1::PropertySet::FAKE_PROP_UUID = "6b6656bb-32c4-4c4a-84ec-f66cf50bd4dd"

staticconstexpr

A fake property is needed when we want to create a property set which does not contain any property (but one or more property sets).

◆ XML_NS

char const* resqml2_0_1::PropertySet::XML_NS = "resqml20"

staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

char const* resqml2_0_1::PropertySet::XML_TAG = "PropertySet"

staticconstexpr

The standard XML tag without 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.10.1.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

◆ getChildren() [1/2]

◆ getChildren() [2/2]

◆ getChildrenCount()

◆ getParent()

◆ getParentDor()

◆ getProperties()

◆ getProperty()

◆ getPropertyCount()

◆ getXmlNamespace()

◆ getXmlTag()

◆ loadTargetRelationships()

◆ pushBackProperty()

◆ setParent()

Member Data Documentation

◆ FAKE_PROP_UUID

◆ XML_NS

◆ XML_TAG