resqml2_0_1::PropertySet Class Reference

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

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

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

inlinefinal

Get the standard XML namespace for serializing this data object.

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.

loadTargetRelationships()

void resqml2_0_1::PropertySet::loadTargetRelationships ( )

final

Loads target relationships

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

XML_NS

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

staticconstexpr

The standard XML namespace for serializing this data object.

XML_TAG

constexpr 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.9.0.1/src/resqml2_0_1/PropertySet.h