Fesapi 2.7.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::PropertySet Class Referencefinal

#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
 
bool hasMultipleRealizations () const final
 
bool hasSinglePropertyKind () const final
 
gsoap_resqml2_0_1::resqml20__TimeSetKind getTimeSetKind () const final
 
std::string getXmlNamespace () const final
 

Static Public Attributes

static const char * XML_NS
 

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]partialObjectIf 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_argumentIf repo == nullptr.
std::invalid_argumentIf timeSetKind is single time series.
Parameters
[in]repoThe DataObjectRepository where the instance must be created.
guidA guid for the instance to create. Empty guid lead to the creation of a random one.
titleA title for the instance to create.
hasMultipleRealizationsIf true, indicates that the collection contains properties with defined realization indices.
hasSinglePropertyKindIf true, indicates that the collection contains only property values associated with a single property kind.
timeSetKindthe 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]fromGsoapIf 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

◆ getXmlNamespace()

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

Get the standard XML namespace for serializing this data object.

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: