OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
ComRef.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenModelica.
3  *
4  * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
5  * c/o Linköpings universitet, Department of Computer and Information Science,
6  * SE-58183 Linköping, Sweden.
7  *
8  * All rights reserved.
9  *
10  * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
11  * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
12  * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
13  * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
14  * ACCORDING TO RECIPIENTS CHOICE.
15  *
16  * The OpenModelica software and the Open Source Modelica
17  * Consortium (OSMC) Public License (OSMC-PL) are obtained
18  * from OSMC, either from the above address,
19  * from the URLs: http://www.ida.liu.se/projects/OpenModelica or
20  * http://www.openmodelica.org, and in the OpenModelica distribution.
21  * GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
22  *
23  * This program is distributed WITHOUT ANY WARRANTY; without
24  * even the implied warranty of MERCHANTABILITY or FITNESS
25  * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
26  * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
27  *
28  * See the full OSMC Public License conditions for more details.
29  *
30  */
31 
32 #ifndef _OMS_COM_REF_H_
33 #define _OMS_COM_REF_H_
34 
35 #include <string>
36 
37 namespace oms
38 {
46  class ComRef
47  {
48  public:
49  ComRef();
50  ComRef(const std::string& path);
51  ComRef(const char* path);
52  ~ComRef();
53 
54  // methods to copy the component reference
55  ComRef(const ComRef& copy);
56  ComRef& operator=(const ComRef& copy);
57  ComRef operator+(const ComRef& rhs) const;
58 
59  static bool isValidIdent(const std::string& ident);
60  bool isValidIdent() const;
61 
62  bool isEmpty() const;
63  bool isRootOf(ComRef child) const;
64 
65  ComRef front() const;
66  ComRef pop_front();
67 
68  std::string suffix() const;
69  std::string pop_suffix();
70  bool pop_suffix(const std::string& suffix);
71 
72  bool hasSuffix() const;
73  bool hasSuffix(const std::string& suffix) const;
74 
75  const char* c_str() const { return cref; }
76  size_t size() const;
77  operator std::string() const { return std::string(cref); }
78 
79  private:
80  char* cref;
81  };
82 
83  bool operator==(const ComRef& lhs, const ComRef& rhs);
84  bool operator!=(const ComRef& lhs, const ComRef& rhs);
85  bool operator<(const ComRef& lhs, const ComRef& rhs);
86 }
87 
88 namespace std
89 {
90  template <>
91  struct hash<oms::ComRef>
92  {
93  size_t operator()(const oms::ComRef& cref) const
94  {
95  return hash<std::string>()(std::string(cref));
96  }
97  };
98 }
99 
100 #endif
const char * c_str() const
Definition: ComRef.h:75
char * cref
Definition: ComRef.h:80
ComRef front() const
returns the first part of the ComRef (including suffix if its the only part)
Definition: ComRef.cpp:166
Definition: ComRef.h:88
ComRef & operator=(const ComRef &copy)
Definition: ComRef.cpp:67
ComRef operator+(const ComRef &rhs) const
return ComRef(lhs + rhs) - Obs! lhs will lose its suffix
Definition: ComRef.cpp:79
~ComRef()
Definition: ComRef.cpp:57
std::string suffix() const
returns the suffix as string
Definition: ComRef.cpp:146
bool operator!=(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:215
bool operator==(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:210
ComRef - component reference.
Definition: ComRef.h:46
bool operator<(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:220
ComRef pop_front()
returns the first part of the ComRef and removed it from the current object
Definition: ComRef.cpp:184
ComRef()
Definition: ComRef.cpp:42
size_t operator()(const oms::ComRef &cref) const
Definition: ComRef.h:93
bool hasSuffix() const
returns true if the cref has a suffix, i.e. contains ":"
Definition: ComRef.cpp:104
Definition: AlgLoop.h:44
bool isEmpty() const
Definition: ComRef.cpp:99
bool isRootOf(ComRef child) const
Definition: ComRef.cpp:155
size_t size() const
Definition: ComRef.cpp:205
bool isValidIdent() const
Definition: ComRef.cpp:94
std::string pop_suffix()
returns the suffix as string and removes it from the current object
Definition: ComRef.cpp:118