IndexDirectory.h

// 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
{

class IndexDirectory
{
public:
    IndexDirectory();

    explicit IndexDirectory(const std::vector<std::string>& names);

    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;
        }
    }

    std::string getName(int index) const
    {
        if ((index < 0) || (index >= static_cast<int>(m_names.size())))
        {
            return "";
        }
        else
        {
            return m_names[index];
        }
    }

    const std::vector<std::string>& getAllNames() const;

    bool hasEntry(const std::string& name) const
    {
        return ((name.length() > 0) && (m_indices.count(name) > 0));
    }

    size_t size() const
    {
        return m_names.size();
    }

    int getNumEntries() const
    {
        return static_cast<int>(m_names.size());
    }

protected:
    template <typename T>
    friend class NamedDataBuilder;
    friend class DataGroupBuilder;

    IndexDirectory(const IndexDirectory& directory);

    IndexDirectory& operator =(const IndexDirectory& directory);

    int addEntry(const std::string& name);

private:
    std::vector<std::string> m_names;

    std::unordered_map<std::string, int> m_indices;
};

};  // namespace Input
};  // namespace SurgSim

#endif  // SURGSIM_DATASTRUCTURES_INDEXDIRECTORY_H