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
Channel.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 "ChannelIndexDataObject.h"
22
23#include "../MacroDefinitions.h"
24
25namespace WITSML2_1_NS
26{
28 class Channel : public ChannelIndexDataObject<gsoap_eml2_3::witsml21__Channel>
29 {
30 public:
31
37 DLL_IMPORT_OR_EXPORT Channel(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : ChannelIndexDataObject<gsoap_eml2_3::witsml21__Channel>(partialObject) {}
38
53 Channel(EML2_NS::PropertyKind * propertyKind,
54 const std::string & guid, const std::string & title,
55 const std::string & mnemonic, gsoap_eml2_3::eml23__UnitOfMeasure uom, gsoap_eml2_3::witsml21__ChannelDataKind dataKind,
56 bool isActive);
57
63 Channel(gsoap_eml2_3::witsml21__Channel* fromGsoap):ChannelIndexDataObject<gsoap_eml2_3::witsml21__Channel>(fromGsoap) {}
64
66 ~Channel() = default;
67
76 DLL_IMPORT_OR_EXPORT void pushBackChannelIndex(gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string & mnemonic, bool isIncreasing = true) final;
77
83 DLL_IMPORT_OR_EXPORT std::vector<class ChannelSet*> getChannelSets() const;
84
90 DLL_IMPORT_OR_EXPORT EML2_NS::PropertyKind* getPropertyKind() const;
91
97 COMMON_NS::DataObjectReference getPropertyKindDor() const;
98
106 DLL_IMPORT_OR_EXPORT void setPropertyKind(EML2_NS::PropertyKind* propKind);
107
108 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(std::string, Mnemonic)
109 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(std::string, Uom)
110 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(gsoap_eml2_3::witsml21__ChannelDataKind, DataKind)
111
118#define SETTER_GENERIC_OPTIONAL_ATTRIBUTE(attributeDatatype, attributeName)\
119 DLL_IMPORT_OR_EXPORT void set##attributeName(const attributeDatatype & attributeName);
120
121 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, RunNumber)
122 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, PassNumber)
123
124
129 DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
130
136 DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const { return XML_TAG; }
137
140
144 DLL_IMPORT_OR_EXPORT static constexpr char const* XML_NS = "witsml21";
145
149 DLL_IMPORT_OR_EXPORT std::string getXmlNamespace() const final { return XML_NS; }
150 };
151}
Definition Channel.h:29
Channel(eml2 ::PropertyKind *propertyKind, const std::string &guid, const std::string &title, const std::string &mnemonic, gsoap_eml2_3::eml23__UnitOfMeasure uom, gsoap_eml2_3::witsml21__ChannelDataKind dataKind, bool isActive)
Creates an instance of this class in a gsoap context.
Channel(gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
Definition Channel.h:37
Channel(gsoap_eml2_3::witsml21__Channel *fromGsoap)
Definition Channel.h:63
void loadTargetRelationships() final
void pushBackChannelIndex(gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string &mnemonic, bool isIncreasing=true) final
Definition ChannelIndexDataObject.h:36
Definition ChannelSet.h:30