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 #include <cstring>
37 
38 namespace oms
39 {
43  class ComRef
44  {
45  public:
46  ComRef();
47  ComRef(const std::string& path);
48  ComRef(const char* path);
49  ~ComRef();
50 
51  // methods to copy the component reference
52  ComRef(const ComRef& copy);
53  ComRef& operator=(const ComRef& copy);
54  ComRef operator+(const ComRef& rhs) const;
55 
56  static bool isValidIdent(const std::string& ident);
57  bool isValidIdent() const;
58  bool isEmpty() const;
59  bool isRootOf(ComRef child) const;
60 
61  ComRef front() const;
62  ComRef pop_front();
63 
64  bool hasSuffixStart() const;
65  ComRef popSuffix() const;
66 
67  const char* c_str() const {return cref;}
68  size_t size() {return strlen(cref);}
69  operator std::string() const {return std::string(cref);}
70 
71  private:
72  char* cref;
73  };
74 
75  bool operator==(const ComRef& lhs, const ComRef& rhs);
76  bool operator!=(const ComRef& lhs, const ComRef& rhs);
77  bool operator<(const ComRef& lhs, const ComRef& rhs);
78 }
79 
80 namespace std
81 {
82  template <>
83  struct hash<oms::ComRef>
84  {
85  size_t operator()(const oms::ComRef& cref) const
86  {
87  return hash<std::string>()(std::string(cref));
88  }
89  };
90 }
91 
92 #endif
const char * c_str() const
Definition: ComRef.h:67
char * cref
Definition: ComRef.h:72
ComRef front() const
Definition: ComRef.cpp:150
bool hasSuffixStart() const
Definition: ComRef.cpp:101
Definition: ComRef.h:80
ComRef & operator=(const ComRef &copy)
Definition: ComRef.cpp:68
ComRef operator+(const ComRef &rhs) const
Definition: ComRef.cpp:81
~ComRef()
Definition: ComRef.cpp:57
bool operator!=(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:190
ComRef popSuffix() const
Definition: ComRef.cpp:121
bool operator==(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:185
ComRef - component reference.
Definition: ComRef.h:43
bool operator<(const ComRef &lhs, const ComRef &rhs)
Definition: ComRef.cpp:195
ComRef pop_front()
Definition: ComRef.cpp:166
ComRef()
Definition: ComRef.cpp:38
size_t operator()(const oms::ComRef &cref) const
Definition: ComRef.h:85
size_t size()
Definition: ComRef.h:68
Definition: AlgLoop.h:44
bool isEmpty() const
Definition: ComRef.cpp:96
bool isRootOf(ComRef child) const
Definition: ComRef.cpp:139
bool isValidIdent() const
Definition: ComRef.cpp:91