Groups.h

// This file is a part of the OpenSurgSim project.
// Copyright 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_GROUPS_H
#define SURGSIM_DATASTRUCTURES_GROUPS_H

#include <unordered_map>
#include <unordered_set>
#include <vector>

#include <boost/thread.hpp>

namespace SurgSim
{


namespace DataStructures
{

template <typename Key, typename T>
class Groups
{
public:

    typedef Key IdentifierType;
    typedef T MemberType;

    bool add(const Key& group, const T& element);

    bool add(const std::vector<Key>& groups, const T& element);

    bool add(const Groups<Key, T>& other);

    bool remove(const Key& group, const T& element);

    bool remove(const T& element);

    std::vector<T> getMembers(const Key& group) const;

    std::vector<Key> getGroups(const T& element) const;

    std::vector<Key> getGroups() const;

    std::vector<T> operator[](const Key& group) const;

    void clear();


private:

    typedef boost::shared_lock<boost::shared_mutex> SharedLock;
    typedef boost::unique_lock<boost::shared_mutex> UniqueLock;

    mutable boost::shared_mutex m_mutex;

    std::unordered_map<Key, std::unordered_set<T>> m_groups;

    std::unordered_map<T, std::unordered_set<Key>> m_membership;
};

}
}

#include "SurgSim/DataStructures/Groups-inl.h"

#endif