Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
ActivityTemplate.h
1 /*-----------------------------------------------------------------------
2 Licensed to the Apache Software Foundation (ASF) under one
3 or more contributor license agreements. See the NOTICE file
4 distributed with this work for additional information
5 regarding copyright ownership. The ASF licenses this file
6 to you under the Apache License, Version 2.0 (the
7 "License"; you may not use this file except in compliance
8 with the License. You may obtain a copy of the License at
9 
10  http://www.apache.org/licenses/LICENSE-2.0
11 
12 Unless required by applicable law or agreed to in writing,
13 software distributed under the License is distributed on an
14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 KIND, either express or implied. See the License for the
16 specific language governing permissions and limitations
17 under the License.
18 -----------------------------------------------------------------------*/
19 #pragma once
20 
21 #include "../eml2/ActivityTemplate.h"
22 
23 namespace EML2_3_NS
24 {
26  class ActivityTemplate final : public EML2_NS::ActivityTemplate
27  {
28  public:
29 
37  DLL_IMPORT_OR_EXPORT ActivityTemplate(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : EML2_NS::ActivityTemplate(partialObject) {}
38 
48  ActivityTemplate(COMMON_NS::DataObjectRepository * repo, const std::string & guid, const std::string & title);
49 
55  ActivityTemplate(gsoap_eml2_3::_eml23__ActivityTemplate* fromGsoap) : EML2_NS::ActivityTemplate(fromGsoap) {}
56 
58  ~ActivityTemplate() = default;
59 
70  DLL_IMPORT_OR_EXPORT void pushBackParameter(const std::string & title,
71  bool isInput, bool isOutput,
72  unsigned int minOccurs, int maxOccurs);
73 
85  DLL_IMPORT_OR_EXPORT void pushBackParameter(const std::string & title,
86  gsoap_resqml2_0_1::resqml20__ParameterKind kind,
87  bool isInput, bool isOutput,
88  unsigned int minOccurs, int maxOccurs);
89 
102  DLL_IMPORT_OR_EXPORT void pushBackParameter(const std::string & title,
103  bool isInput, bool isOutput,
104  unsigned int minOccurs, int maxOccurs,
105  std::string resqmlObjectContentType);
106 
114  DLL_IMPORT_OR_EXPORT bool isAnExistingParameter(const std::string & paramTitle) const;
115 
121  DLL_IMPORT_OR_EXPORT unsigned int getParameterCount() const;
122 
130  DLL_IMPORT_OR_EXPORT const std::string & getParameterTitle(unsigned int index) const;
131 
139  DLL_IMPORT_OR_EXPORT std::vector<gsoap_resqml2_0_1::resqml20__ParameterKind> getParameterAllowedKinds(unsigned int index) const;
140 
148  DLL_IMPORT_OR_EXPORT std::vector<gsoap_resqml2_0_1::resqml20__ParameterKind> getParameterAllowedKinds(const std::string & paramTitle) const;
149 
157  DLL_IMPORT_OR_EXPORT bool getParameterIsInput(unsigned int index) const;
158 
166  DLL_IMPORT_OR_EXPORT bool getParameterIsInput(const std::string & paramTitle) const;
167 
175  DLL_IMPORT_OR_EXPORT bool getParameterIsOutput(unsigned int index) const;
176 
184  DLL_IMPORT_OR_EXPORT bool getParameterIsOutput(const std::string & paramTitle) const;
185 
193  DLL_IMPORT_OR_EXPORT int64_t getParameterMinOccurences(unsigned int index) const;
194 
202  DLL_IMPORT_OR_EXPORT int64_t getParameterMinOccurences(const std::string & paramTitle) const;
203 
211  DLL_IMPORT_OR_EXPORT int64_t getParameterMaxOccurences(unsigned int index) const;
212 
220  DLL_IMPORT_OR_EXPORT int64_t getParameterMaxOccurences(const std::string & paramTitle) const;
221 
225  DLL_IMPORT_OR_EXPORT static const char* XML_NS;
226 
230  DLL_IMPORT_OR_EXPORT std::string getXmlNamespace() const final { return XML_NS; }
231 
232  private:
233 
241  gsoap_eml2_3::eml23__ParameterTemplate* getParameterFromTitle(const std::string & paramTitle) const;
242  };
243 }
Definition: ActivityTemplate.h:27
int64_t getParameterMaxOccurences(const std::string &paramTitle) const
void pushBackParameter(const std::string &title, gsoap_resqml2_0_1::resqml20__ParameterKind kind, bool isInput, bool isOutput, unsigned int minOccurs, int maxOccurs)
std::vector< gsoap_resqml2_0_1::resqml20__ParameterKind > getParameterAllowedKinds(unsigned int index) const
int64_t getParameterMaxOccurences(unsigned int index) const
static const char * XML_NS
Definition: ActivityTemplate.h:225
bool getParameterIsInput(unsigned int index) const
int64_t getParameterMinOccurences(unsigned int index) const
void pushBackParameter(const std::string &title, bool isInput, bool isOutput, unsigned int minOccurs, int maxOccurs, std::string resqmlObjectContentType)
std::vector< gsoap_resqml2_0_1::resqml20__ParameterKind > getParameterAllowedKinds(const std::string &paramTitle) const
int64_t getParameterMinOccurences(const std::string &paramTitle) const
std::string getXmlNamespace() const final
Definition: ActivityTemplate.h:230
bool getParameterIsOutput(const std::string &paramTitle) const
ActivityTemplate(gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
Definition: ActivityTemplate.h:37
const std::string & getParameterTitle(unsigned int index) const
ActivityTemplate(common::DataObjectRepository *repo, const std::string &guid, const std::string &title)
ActivityTemplate(gsoap_eml2_3::_eml23__ActivityTemplate *fromGsoap)
Definition: ActivityTemplate.h:55
bool isAnExistingParameter(const std::string &paramTitle) const
bool getParameterIsInput(const std::string &paramTitle) const
void pushBackParameter(const std::string &title, bool isInput, bool isOutput, unsigned int minOccurs, int maxOccurs)
unsigned int getParameterCount() const
bool getParameterIsOutput(unsigned int index) const