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::PropertySet:

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

virtual	~PropertySet ()=default

void	setParent (PropertySet *parent)

virtual common::DataObjectReference	getParentDor () const =0

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 bool	hasMultipleRealizations () const =0

virtual bool	hasSinglePropertyKind () const =0

virtual gsoap_resqml2_0_1::resqml20__TimeSetKind	getTimeSetKind () const =0

virtual std::string	getXmlTag () const final

void	loadTargetRelationships () final

Static Public Attributes
static const char *	XML_TAG

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()

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

inline

Only to be used in partial transfer context.

Parameters

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

◆ ~PropertySet()

virtual resqml2::PropertySet::~PropertySet ( )

virtualdefault

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

Member Function Documentation

◆ getChildren() [1/2]

std::vector< PropertySet * > resqml2::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::PropertySet::getChildren ( unsigned int 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()

unsigned int resqml2::PropertySet::getChildrenCount ( ) const

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

Exceptions

std::range_error If the count of children property set is strictly greater than unsigned int max.

Returns: The children count.

◆ getParent()

PropertySet * resqml2::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()

virtual common::DataObjectReference resqml2::PropertySet::getParentDor ( ) const

pure virtual

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::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::PropertySet::getProperty ( unsigned int 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()

unsigned int resqml2::PropertySet::getPropertyCount ( ) const

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.

◆ getTimeSetKind()

virtual gsoap_resqml2_0_1::resqml20__TimeSetKind resqml2::PropertySet::getTimeSetKind ( ) const

pure virtual

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.

◆ getXmlTag()

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

inlinefinalvirtual

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

Returns: The XML tag.

◆ hasMultipleRealizations()

virtual bool resqml2::PropertySet::hasMultipleRealizations ( ) const

pure virtual

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.

◆ hasSinglePropertyKind()

virtual bool resqml2::PropertySet::hasSinglePropertyKind ( ) const

pure virtual

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.

◆ loadTargetRelationships()

void resqml2::PropertySet::loadTargetRelationships ( )

final

Loads target relationships

◆ pushBackProperty()

void resqml2::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::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_TAG

const char* resqml2::PropertySet::XML_TAG

static

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.7.0.0/src/resqml2/PropertySet.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PropertySet()

◆ ~PropertySet()

Member Function Documentation

◆ getChildren() [1/2]

◆ getChildren() [2/2]

◆ getChildrenCount()

◆ getParent()

◆ getParentDor()

◆ getProperties()

◆ getProperty()

◆ getPropertyCount()

◆ getTimeSetKind()

◆ getXmlTag()

◆ hasMultipleRealizations()

◆ hasSinglePropertyKind()

◆ loadTargetRelationships()

◆ pushBackProperty()

◆ setParent()

Member Data Documentation

◆ XML_TAG