Fesapi 2.9.0.1
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_2::CommentProperty Class Referencefinal

#include <CommentProperty.h>

Inheritance diagram for resqml2_2::CommentProperty:

Public Member Functions

 CommentProperty (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 CommentProperty (resqml2 ::AbstractRepresentation *rep, const std::string &guid, const std::string &title, unsigned int dimension, gsoap_eml2_3::eml23__IndexableElement attachmentKind, eml2 ::PropertyKind *propKind)
 
 CommentProperty (gsoap_eml2_3::_resqml22__CommentProperty *fromGsoap)
 
 ~CommentProperty ()=default
 
std::string pushBackRefToExistingDataset (eml2 ::AbstractHdfProxy *hdfProxy, const std::string &datasetName="") final
 
bool validatePropertyKindAssociation (eml2 ::PropertyKind *) final
 
bool validatePropertyKindAssociation (gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind) final
 
std::string getXmlNamespace () const final
 

Static Public Attributes

static const char * XML_NS
 

Detailed Description

Proxy class for a comment property.

Constructor & Destructor Documentation

◆ CommentProperty() [1/3]

resqml2_2::CommentProperty::CommentProperty ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Only to be used in partial transfer context.

Parameters
[in]partialObjectIf non-null, the partial object.

◆ CommentProperty() [2/3]

resqml2_2::CommentProperty::CommentProperty ( resqml2 ::AbstractRepresentation * rep,
const std::string & guid,
const std::string & title,
unsigned int dimension,
gsoap_eml2_3::eml23__IndexableElement attachmentKind,
eml2 ::PropertyKind * propKind )

Creates a comment property which is of a local property kind.

Exceptions
std::invalid_argumentIf rep or propKind is null.. If dimension is zero.
Parameters
[in]repThe representation on which this property is attached to. It cannot be null.
guidThe guid to set to the property. If empty then a new guid will be generated.
titleThe title to set to the property. If empty then "unknown" title will be set.
dimensionThe dimension of each value of this property. Dimension is 1 for a scalar property.
attachmentKindThe topological element on which the property values are attached to.
[in]propKindThe property kind of these property values. It cannot be null.

◆ CommentProperty() [3/3]

resqml2_2::CommentProperty::CommentProperty ( gsoap_eml2_3::_resqml22__CommentProperty * fromGsoap)
inline

Creates an instance of this class by wrapping a gSOAP instance.

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ ~CommentProperty()

resqml2_2::CommentProperty::~CommentProperty ( )
default

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

Member Function Documentation

◆ getXmlNamespace()

std::string resqml2_2::CommentProperty::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::CommentProperty::XML_NS
static

The standard XML namespace for serializing this data object.


The documentation for this class was generated from the following file: