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_eml2_3::resqml22__TimeSetKind	getTimeSetKind () const =0

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

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

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.

Reimplemented in resqml2_2::PropertySet, and resqml2_0_1::PropertySet.

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_eml2_3::resqml22__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.

Implemented in resqml2_2::PropertySet, and resqml2_0_1::PropertySet.

◆ 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.

Implements common::AbstractObject.

◆ 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.

Implemented in resqml2_2::PropertySet, and resqml2_0_1::PropertySet.

◆ 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.

Implemented in resqml2_2::PropertySet, and resqml2_0_1::PropertySet.

◆ loadTargetRelationships()

void resqml2::PropertySet::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Implements common::AbstractObject.

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

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