Fesapi 2.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
CommentProperty.h
1/*-----------------------------------------------------------------------
2Licensed to the Apache Software Foundation (ASF) under one
3or more contributor license agreements. See the NOTICE file
4distributed with this work for additional information
5regarding copyright ownership. The ASF licenses this file
6to you under the Apache License, Version 2.0 (the
7"License"; you may not use this file except in compliance
8with the License. You may obtain a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12Unless required by applicable law or agreed to in writing,
13software distributed under the License is distributed on an
14"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15KIND, either express or implied. See the License for the
16specific language governing permissions and limitations
17under the License.
18-----------------------------------------------------------------------*/
19#pragma once
20
21#include "AbstractValuesProperty.h"
22
23#include <limits>
24
25namespace RESQML2_NS
26{
32 class CommentProperty : public AbstractValuesProperty
33 {
34 public:
35
37 virtual ~CommentProperty() = default;
38
42 std::string pushBackRefToExistingIntegerDataset(EML2_NS::AbstractHdfProxy*, const std::string&, int64_t) final {
43 throw std::logic_error("You cannot push back integer values in a Continuous Property.");
44 }
45
55 DLL_IMPORT_OR_EXPORT void pushBackStringHdf5ArrayOfValues(const std::vector<std::string> & values, EML2_NS::AbstractHdfProxy* proxy);
56
72 DLL_IMPORT_OR_EXPORT virtual std::string pushBackRefToExistingDataset(EML2_NS::AbstractHdfProxy* hdfProxy, const std::string & datasetName = "") = 0;
73
83 DLL_IMPORT_OR_EXPORT std::vector<std::string> getStringValuesOfPatch(unsigned int patchIndex);
84
86 DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "CommentProperty";
87
88 DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const final { return XML_TAG; }
89
90 protected:
91
97 DLL_IMPORT_OR_EXPORT CommentProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractValuesProperty(partialObject) {}
98
99 CommentProperty() {}
100
106 CommentProperty(gsoap_resqml2_0_1::_resqml20__CommentProperty* fromGsoap) : AbstractValuesProperty(fromGsoap) {}
107
113 CommentProperty(gsoap_eml2_3::_resqml22__CommentProperty* fromGsoap) : AbstractValuesProperty(fromGsoap) {}
114
115 virtual EML2_NS::AbstractHdfProxy* getValuesHdfProxyAndDatasetPathOfPatch(unsigned int patchIndex, std::string & datasetPath) const = 0;
116 };
117}
Proxy class for an abstract values property.
Definition AbstractValuesProperty.h:27
Proxy class for a comment property. It is used to capture comments or annotations associated with a g...
Definition CommentProperty.h:33
virtual std::string getXmlTag() const final
Definition CommentProperty.h:88
std::vector< std::string > getStringValuesOfPatch(unsigned int patchIndex)
static constexpr char const * XML_TAG
Definition CommentProperty.h:86
virtual ~CommentProperty()=default
void pushBackStringHdf5ArrayOfValues(const std::vector< std::string > &values, eml2::AbstractHdfProxy *proxy)
std::string pushBackRefToExistingIntegerDataset(eml2::AbstractHdfProxy *, const std::string &, int64_t) final
Definition CommentProperty.h:42
virtual std::string pushBackRefToExistingDataset(eml2::AbstractHdfProxy *hdfProxy, const std::string &datasetName="")=0