OMSimulatorLib The OMSimulator project is a FMI-based co-simulation environment.

Loading...
Searching...
No Matches
ComRef.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenModelica.
3 *
4 * Copyright (c) 1998-2026, 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 AGPL VERSION 3 LICENSE OR
11 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
12 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
13 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
14 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
15 *
16 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
17 * Public License (OSMC-PL) are obtained from OSMC, either from the above
18 * address, from the URLs:
19 * http://www.openmodelica.org or
20 * https://github.com/OpenModelica/ or
21 * http://www.ida.liu.se/projects/OpenModelica,
22 * and in the OpenModelica distribution.
23 *
24 * GNU AGPL version 3 is obtained from:
25 * https://www.gnu.org/licenses/licenses.html#GPL
26 *
27 * This program is distributed WITHOUT ANY WARRANTY; without
28 * even the implied warranty of MERCHANTABILITY or FITNESS
29 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
30 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
31 *
32 * See the full OSMC Public License conditions for more details.
33 *
34 */
35
36#ifndef _OMS_COM_REF_H_
37#define _OMS_COM_REF_H_
38
39#include <string>
40
41 namespace oms
42{
50 class ComRef
51 {
52 public:
53 ComRef();
54 ComRef(const std::string& path);
55 ComRef(const char* path);
56 ~ComRef();
57
58 // methods to copy the component reference
59 ComRef(const ComRef& copy);
60 ComRef& operator=(const ComRef& copy);
61 ComRef operator+(const ComRef& rhs) const;
62
63 static bool isValidIdent(const std::string& ident);
64 bool isValidIdent() const;
65
66 bool isEmpty() const;
67 bool isRootOf(ComRef child) const;
68
69 ComRef front() const;
70 ComRef pop_front();
71
72 std::string suffix() const;
73 std::string pop_suffix();
74 bool pop_suffix(const std::string& suffix);
75
76 bool hasSuffix() const;
77 bool hasSuffix(const std::string& suffix) const;
78
79 const char* c_str() const { return cref; }
80 size_t size() const;
81 operator std::string() const { return std::string(cref); }
82
83 private:
84 char* cref;
85 };
86
87 bool operator==(const ComRef& lhs, const ComRef& rhs);
88 bool operator!=(const ComRef& lhs, const ComRef& rhs);
89 bool operator<(const ComRef& lhs, const ComRef& rhs);
90}
91
92 namespace std
93{
94 template <>
95 struct hash<oms::ComRef>
96 {
97 size_t operator()(const oms::ComRef& cref) const
98 {
99 return hash<std::string>()(std::string(cref));
100 }
101 };
102}
103
104#endif
oms::ComRef
ComRef - component reference.
Definition ComRef.h:51
oms::ComRef::pop_suffix
std::string pop_suffix()
returns the suffix as string and removes it from the current object
Definition ComRef.cpp:122
oms::ComRef::~ComRef
~ComRef()
Definition ComRef.cpp:61
oms::ComRef::pop_front
ComRef pop_front()
returns the first part of the ComRef and removed it from the current object
Definition ComRef.cpp:188
oms::ComRef::suffix
std::string suffix() const
returns the suffix as string
Definition ComRef.cpp:150
oms::ComRef::c_str
const char * c_str() const
Definition ComRef.h:79
oms::ComRef::operator+
ComRef operator+(const ComRef &rhs) const
return ComRef(lhs + rhs) - Obs! lhs will lose its suffix
Definition ComRef.cpp:83
oms::ComRef::isEmpty
bool isEmpty() const
Definition ComRef.cpp:103
oms::ComRef::cref
char * cref
Definition ComRef.h:84
oms::ComRef::operator=
ComRef & operator=(const ComRef &copy)
Definition ComRef.cpp:71
oms::ComRef::isRootOf
bool isRootOf(ComRef child) const
Definition ComRef.cpp:159
oms::ComRef::ComRef
ComRef()
Definition ComRef.cpp:46
oms::ComRef::size
size_t size() const
Definition ComRef.cpp:209
oms::ComRef::front
ComRef front() const
returns the first part of the ComRef (including suffix if its the only part)
Definition ComRef.cpp:170
oms::ComRef::hasSuffix
bool hasSuffix() const
returns true if the cref has a suffix, i.e. contains ":"
Definition ComRef.cpp:108
oms::ComRef::isValidIdent
bool isValidIdent() const
Definition ComRef.cpp:98
oms
Definition AlgLoop.h:52
oms::operator<
bool operator<(const ComRef &lhs, const ComRef &rhs)
Definition ComRef.cpp:224
oms::operator==
bool operator==(const ComRef &lhs, const ComRef &rhs)
Definition ComRef.cpp:214
oms::operator!=
bool operator!=(const ComRef &lhs, const ComRef &rhs)
Definition ComRef.cpp:219
std
Definition ComRef.h:93
std::hash< oms::ComRef >::operator()
size_t operator()(const oms::ComRef &cref) const
Definition ComRef.h:97