Fesapi 2.3.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
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_0_NS
26{
28 class Channel : public ChannelIndexDataObject<gsoap_eml2_1::witsml20__Channel>
29 {
30 public:
31
37 DLL_IMPORT_OR_EXPORT Channel(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : ChannelIndexDataObject<gsoap_eml2_1::witsml20__Channel>(partialObject) {}
38
55 Channel(EML2_NS::PropertyKind * propertyKind,
56 const std::string & guid, const std::string & title,
57 const std::string & mnemonic, gsoap_eml2_1::eml21__UnitOfMeasure uom, gsoap_eml2_1::witsml20__EtpDataType dataType, gsoap_eml2_1::witsml20__ChannelStatus growingStatus,
58 const std::string & timeDepth, const std::string & loggingCompanyName);
59
65 Channel(gsoap_eml2_1::witsml20__Channel* fromGsoap):ChannelIndexDataObject<gsoap_eml2_1::witsml20__Channel>(fromGsoap) {}
66
68 ~Channel() = default;
69
79 DLL_IMPORT_OR_EXPORT void pushBackChannelIndex(gsoap_eml2_1::witsml20__ChannelIndexType indexType, gsoap_eml2_1::eml21__UnitOfMeasure uom, const std::string & mnemonic, bool isIncreasing = true, const std::string & datum = "");
80
86 DLL_IMPORT_OR_EXPORT std::vector<class ChannelSet*> getChannelSets() const;
87
93 DLL_IMPORT_OR_EXPORT EML2_NS::PropertyKind* getPropertyKind() const;
94
100 COMMON_NS::DataObjectReference getPropertyKindDor() const;
101
102 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(std::string, Mnemonic)
103 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(std::string, Uom)
104 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(gsoap_eml2_1::witsml20__EtpDataType, DataType)
105 GETTER_AND_SETTER_GENERIC_ATTRIBUTE(gsoap_eml2_1::witsml20__ChannelStatus, GrowingStatus)
106
107
113#define SETTER_GENERIC_OPTIONAL_ATTRIBUTE(attributeDatatype, attributeName)\
114 DLL_IMPORT_OR_EXPORT void set##attributeName(const attributeDatatype & attributeName);
115
116 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, TimeDepth)
117 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, RunNumber)
118 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, PassNumber)
119 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, LoggingCompanyName)
120 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, LoggingCompanyCode)
121 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, ToolName)
122 SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, ToolClass)
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 = "witsml20";
145
149 DLL_IMPORT_OR_EXPORT std::string getXmlNamespace() const final { return XML_NS; }
150 };
151}
Definition: Channel.h:29
Channel(gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
Definition: Channel.h:37
std::vector< class ChannelSet * > getChannelSets() const
common::DataObjectReference getPropertyKindDor() const
Gets property kind dor.
Channel(gsoap_eml2_1::witsml20__Channel *fromGsoap)
Definition: Channel.h:65
eml2::PropertyKind * getPropertyKind() const
void pushBackChannelIndex(gsoap_eml2_1::witsml20__ChannelIndexType indexType, gsoap_eml2_1::eml21__UnitOfMeasure uom, const std::string &mnemonic, bool isIncreasing=true, const std::string &datum="")
void loadTargetRelationships() final
Channel(eml2::PropertyKind *propertyKind, const std::string &guid, const std::string &title, const std::string &mnemonic, gsoap_eml2_1::eml21__UnitOfMeasure uom, gsoap_eml2_1::witsml20__EtpDataType dataType, gsoap_eml2_1::witsml20__ChannelStatus growingStatus, const std::string &timeDepth, const std::string &loggingCompanyName)
Creates an instance of this class in a gsoap context.
Definition: ChannelIndexDataObject.h:36