/usr/include/SurgSim/DataStructures/IndexDirectory.h is in libopensurgsim-dev 0.7.0-6ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | // This file is a part of the OpenSurgSim project.
// Copyright 2012-2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SURGSIM_DATASTRUCTURES_INDEXDIRECTORY_H
#define SURGSIM_DATASTRUCTURES_INDEXDIRECTORY_H
#include <string>
#include <unordered_map>
#include <vector>
namespace SurgSim
{
namespace DataStructures
{
/// A simple bidirectional mapping between names (strings) and distinct consecutive non-negative indices.
///
/// Access to this class is thread-safe if all of the threads are only performing const operations, i.e. reading
/// the names and indices.
class IndexDirectory
{
public:
/// Create an empty directory object.
IndexDirectory();
/// Create a directory object initialized to a list of names.
/// \param names The names.
explicit IndexDirectory(const std::vector<std::string>& names);
/// Given a name, return the corresponding index (or -1).
/// \param name The name.
/// \return the index for that name if one exists; -1 otherwise.
int getIndex(const std::string& name) const
{
if (name.length() == 0)
{
return -1;
}
auto entry = m_indices.find(name);
if (entry == m_indices.cend())
{
return -1;
}
else
{
return entry->second;
}
}
/// Given an index, return the corresponding name (or "").
/// \param index The index.
/// \return the name for that index if one exists; an empty string otherwise.
std::string getName(int index) const
{
if ((index < 0) || (index >= static_cast<int>(m_names.size())))
{
return "";
}
else
{
return m_names[index];
}
}
/// Get a list of all the names available from the index directory.
/// \return all the names, in index order.
const std::vector<std::string>& getAllNames() const;
/// Check whether the specified name exists in the directory.
///
/// \param name The name.
/// \return true if the entry exists.
bool hasEntry(const std::string& name) const
{
return ((name.length() > 0) && (m_indices.count(name) > 0));
}
/// Check the number of existing entries in the directory.
/// \return the size of the directory.
/// \sa getNumEntries()
size_t size() const
{
return m_names.size();
}
/// Check the number of existing entries in the directory.
/// \return the size of the directory.
/// \sa size()
int getNumEntries() const
{
return static_cast<int>(m_names.size());
}
protected:
template <typename T>
friend class NamedDataBuilder;
friend class DataGroupBuilder;
/// Copy constructor.
/// Not generally accessible by external code, but is used by friend classes.
/// \sa NamedDataBuilder, DataGroupBuilder
IndexDirectory(const IndexDirectory& directory);
/// Assignment operator.
/// Not generally accessible by external code, but is used by friend classes.
/// \sa NamedDataBuilder, DataGroupBuilder
IndexDirectory& operator =(const IndexDirectory& directory);
/// Create a new entry for the specified name.
/// Not generally accessible by external code, but is used by friend classes.
/// \sa NamedDataBuilder, DataGroupBuilder
///
/// \param name The name, which should be non-empty and should not already exist in the directory.
/// \return the index of the created entry, or -1 if the entry could not be added.
int addEntry(const std::string& name);
private:
/// The array of entry names, in index order.
std::vector<std::string> m_names;
/// A mapping of entry names to indices.
std::unordered_map<std::string, int> m_indices;
};
}; // namespace Input
}; // namespace SurgSim
#endif // SURGSIM_DATASTRUCTURES_INDEXDIRECTORY_H
|