/usr/include/SurgSim/DataStructures/NamedVariantData.h is in libopensurgsim-dev 0.7.0-5.
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 | // 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_NAMEDVARIANTDATA_H
#define SURGSIM_DATASTRUCTURES_NAMEDVARIANTDATA_H
#include <boost/any.hpp>
#include "SurgSim/DataStructures/NamedData.h"
#include "SurgSim/DataStructures/NamedDataBuilder.h"
namespace SurgSim
{
namespace DataStructures
{
typedef NamedDataBuilder<boost::any> NamedVariantDataBuilder;
/// A NamedData collection of variant data type.
///
/// A NamedVariantData collection is a collection variant datatypes. Each entry in the collection can be
/// accessed by using either its unique name (a std::string) or its unique index (a non-negative integer).
/// Access by name is more convenient, but also less efficient.
///
/// This sub-class of NameData encapsulates the boost::any variant type, and adds two get functions that
/// provide typed access to the contained data.
class NamedVariantData : public NamedData<boost::any>
{
public:
NamedVariantData();
/// Implicit conversion for NamedVariantData constructor is used on purpose.
NamedVariantData(const NamedData<boost::any>& namedData); //NOLINT
/// Check whether the entry with the specified index contains valid data.
/// The check verifies that the entry's data is of type T, was %set using
/// set(int, const T&) or set(const std::string&, const T&), without being
/// subsequently invalidated by reset(int) or reset(const std::string&).
///
/// \tparam T the data type to check for at the given index.
/// \param index The index of the entry.
/// \return true if that entry exists, is of type T, and contains valid data.
template <typename T>
inline bool hasTypedData(int index) const;
/// Check whether the entry with the specified name contains valid data.
/// The check verifies that the entry's data is of type T, was %set using
/// set(int, const T&) or set(const std::string&, const T&), without being
/// subsequently invalidated by reset(int) or reset(const std::string&).
///
/// \tparam T the data type to check for at the given index.
/// \param name The name of the entry.
/// \return true if that entry exists, is of type T, and contains valid data.
template <typename T>
inline bool hasTypedData(const std::string& name) const;
/// Given an index, get the corresponding value.
/// It's only possible to get the value if the data was %set using set(int, const T&) or
/// set(const std::string&, const T&), without being subsequently invalidated by reset(int)
/// or reset(const std::string&). In other words, get returns the same value as hasData would return.
///
/// \tparam T the data type used for the value at the given index.
/// \param index The index of the entry.
/// \param [out] value The location for the retrieved value. Must not be null.
/// \return true if a valid value is available, was written to \a value, and value is the correct type.
template <typename T>
inline bool get(int index, T* value) const;
/// Given a name, get the corresponding value.
/// It's only possible to get the value if the data was %set using set(int, const T&) or
/// set(const std::string&, const T&), without being subsequently invalidated by reset(int)
/// or reset(const std::string&). In other words, get returns the same value as hasData would return.
///
/// \tparam T the data type used for the value with the given name.
/// \param name The name of the entry.
/// \param [out] value The location for the retrieved value. Must not be null.
/// \return true if a valid value is available, was written to \a value, and value is the correct type.
template <typename T>
inline bool get(const std::string& name, T* value) const;
};
}; // namespace DataStructures
}; // namespace SurgSim
#include "SurgSim/DataStructures/NamedVariantData-inl.h"
#endif // SURGSIM_DATASTRUCTURES_NAMEDVARIANTDATA_H
|