YARP
Yet Another Robot Platform
NestedContact.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3  * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef YARP_OS_NESTEDCONTACT_H
8 #define YARP_OS_NESTEDCONTACT_H
9 
10 #include <yarp/os/api.h>
11 
12 #include <string>
13 
14 namespace yarp {
15 namespace os {
16 
24 {
25 public:
31  NestedContact();
32 
38  NestedContact(const std::string& fullName);
39 
45  NestedContact(const NestedContact& rhs);
46 
52  NestedContact(NestedContact&& rhs) noexcept;
53 
57  ~NestedContact();
58 
65  NestedContact& operator=(const NestedContact& rhs);
66 
73  NestedContact& operator=(NestedContact&& rhs) noexcept;
74 
78  bool fromString(const std::string& nFullName);
79 
80  void setTypeName(const std::string& nWireType);
81 
82  void setCategoryWrite();
83 
84  void setCategoryRead();
85 
86  std::string getFullName() const;
87 
88  std::string getNodeName() const;
89 
90  std::string getNestedName() const;
91 
92  std::string getCategory() const;
93 
94  std::string getTypeName() const;
95 
96  std::string getTypeNameStar() const;
97 
98  bool isNested() const;
99 
100  std::string toString() const;
101 
104 #ifndef DOXYGEN_SHOULD_SKIP_THIS
105 private:
106  class Private;
107  Private* mPriv;
108 #endif // DOXYGEN_SHOULD_SKIP_THIS
109 };
110 
111 } // namespace os
112 } // namespace yarp
113 
114 #endif // YARP_OS_NESTEDCONTACT_H
A placeholder for rich contact information.
Definition: NestedContact.h:24
std::string toString(const T &value)
convert an arbitrary type to string.
The main, catch-all namespace for YARP.
Definition: dirs.h:16
#define YARP_os_API
Definition: api.h:18