YARP
Yet Another Robot Platform
NestedContact.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
3  * Copyright (C) 2006-2010 RobotCub Consortium
4  * All rights reserved.
5  *
6  * This software may be modified and distributed under the terms of the
7  * BSD-3-Clause license. See the accompanying LICENSE file for details.
8  */
9 
10 #ifndef YARP_OS_NESTEDCONTACT_H
11 #define YARP_OS_NESTEDCONTACT_H
12 
13 #include <yarp/os/api.h>
14 
15 #include <string>
16 
17 namespace yarp {
18 namespace os {
19 
27 {
28 public:
34  NestedContact();
35 
41  NestedContact(const std::string& fullName);
42 
48  NestedContact(const NestedContact& rhs);
49 
55  NestedContact(NestedContact&& rhs) noexcept;
56 
60  ~NestedContact();
61 
68  NestedContact& operator=(const NestedContact& rhs);
69 
76  NestedContact& operator=(NestedContact&& rhs) noexcept;
77 
81  bool fromString(const std::string& nFullName);
82 
83  void setTypeName(const std::string& nWireType);
84 
85  void setCategoryWrite();
86 
87  void setCategoryRead();
88 
89  std::string getFullName() const;
90 
91  std::string getNodeName() const;
92 
93  std::string getNestedName() const;
94 
95  std::string getCategory() const;
96 
97  std::string getTypeName() const;
98 
99  std::string getTypeNameStar() const;
100 
101  bool isNested() const;
102 
103  std::string toString() const;
104 
107 #ifndef DOXYGEN_SHOULD_SKIP_THIS
108 private:
109  class Private;
110  Private* mPriv;
111 #endif // DOXYGEN_SHOULD_SKIP_THIS
112 };
113 
114 } // namespace os
115 } // namespace yarp
116 
117 #endif // YARP_OS_NESTEDCONTACT_H
yarp::os::NestedContact
A placeholder for rich contact information.
Definition: NestedContact.h:27
api.h
YARP_os_API
#define YARP_os_API
Definition: api.h:19
yarp::os::NestedContact::Private
Definition: NestedContact.cpp:19
toString
std::string toString(const T &value)
convert an arbitrary type to string.
Definition: fakeMotionControl.cpp:121
yarp
The main, catch-all namespace for YARP.
Definition: environment.h:18