Gazebo Transport

API Reference

14.1.0
TopicUtils.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2014 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16*/
17
18#ifndef GZ_TRANSPORT_TOPICUTILS_HH_
19#define GZ_TRANSPORT_TOPICUTILS_HH_
20
21#include <cstdint>
22#include <string>
23
24#include "gz/transport/config.hh"
25#include "gz/transport/Export.hh"
26
27namespace gz::transport
28{
29 // Inline bracket to help doxygen filtering.
30 inline namespace GZ_TRANSPORT_VERSION_NAMESPACE {
31 //
34 class GZ_TRANSPORT_VISIBLE TopicUtils
35 {
42 public: static bool IsValidNamespace(const std::string &_ns);
43
51 public: static bool IsValidPartition(const std::string &_partition);
52
62 public: static bool IsValidTopic(const std::string &_topic);
63
100 public: static bool FullyQualifiedName(const std::string &_partition,
101 const std::string &_ns,
102 const std::string &_topic,
103 std::string &_name);
104
125 public: static bool DecomposeFullyQualifiedTopic(
126 const std::string &_fullyQualifiedName,
127 std::string &_partition,
128 std::string &_namespaceAndTopic);
129
136 public: static std::string AsValidTopic(const std::string &_topic);
137
141 public: static const uint16_t kMaxNameLength = 65535;
142 };
143 }
144}
145
146#endif