NameManager.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2021, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DART_COMMON_NAMEMANAGER_HPP_
#define DART_COMMON_NAMEMANAGER_HPP_
 
#include <map>
#include <string>
 
namespace dart {
namespace common {
 
template <typename T>
class NameManager
{
public:
  NameManager(
      const std::string& _managerName = "default",
      const std::string& _defaultName = "default");
 
  virtual ~NameManager() = default;
 
  bool setPattern(const std::string& _newPattern);
 
  std::string issueNewName(const std::string& _name) const;
 
  std::string issueNewNameAndAdd(const std::string& _name, const T& _obj);
 
  bool addName(const std::string& _name, const T& _obj);
 
  bool removeName(const std::string& _name);
 
  bool removeObject(const T& _obj);
 
  void removeEntries(const std::string& _name, const T& _obj);
 
  void clear();
 
  bool hasName(const std::string& _name) const;
 
  bool hasObject(const T& _obj) const;
 
  std::size_t getCount() const;
 
  T getObject(const std::string& _name) const;
 
  std::string getName(const T& _obj) const;
 
  std::string changeObjectName(const T& _obj, const std::string& _newName);
 
  void setDefaultName(const std::string& _defaultName);
 
  const std::string& getDefaultName() const;
 
  void setManagerName(const std::string& _managerName);
 
  const std::string& getManagerName() const;
 
protected:
  std::string mManagerName;
 
  std::map<std::string, T> mMap;
 
  std::map<T, std::string> mReverseMap;
 
  std::string mDefaultName;
 
  bool mNameBeforeNumber;
 
  std::string mPrefix;
 
  std::string mInfix;
 
  std::string mAffix;
};
 
} // namespace common
} // namespace dart
 
#include "dart/common/detail/NameManager.hpp"
 
#endif // DART_COMMON_NAMEMANAGER_HPP_