ComponentManager.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013-2016, 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_FRAMEWORK_COMPONENTMANAGER_H
#define SURGSIM_FRAMEWORK_COMPONENTMANAGER_H

#include <memory>
#include <string>
#include <vector>

#include <boost/thread/mutex.hpp>

#include "SurgSim/Framework/BasicThread.h"
#include "SurgSim/Framework/Behavior.h"
#include "SurgSim/Framework/Log.h"
#include "SurgSim/Framework/Component.h"

namespace SurgSim
{
namespace Framework
{

class Runtime;
class Logger;

class ComponentManager : public BasicThread
{
public:

    explicit ComponentManager(const std::string& name = "Unknown Component Manager");
    virtual ~ComponentManager();

    bool enqueueAddComponent(const std::shared_ptr<Component>& component);

    bool enqueueRemoveComponent(const std::shared_ptr<Component>& component);

    std::shared_ptr<Runtime> getRuntime() const;
    void setRuntime(std::shared_ptr<Runtime> val);

protected:
    template<class T>
    std::shared_ptr<T> tryAddComponent(std::shared_ptr<SurgSim::Framework::Component> component,
                                       std::vector<std::shared_ptr<T>>* container);

    template<class T>
    bool tryRemoveComponent(std::shared_ptr<SurgSim::Framework::Component> component,
                            std::vector<std::shared_ptr<T>>* container);


    void processComponents();

    void processBehaviors(const double dt);

    // Enum is defined in the beginning of this file
    virtual int getType() const = 0;

    void copyScheduledComponents(std::vector<std::shared_ptr<Component>>* inflightAdditions,
                                 std::vector<std::shared_ptr<Component>>* inflightRemovals,
                                 std::vector<std::shared_ptr<SceneElement>>* inflightElements);

    std::shared_ptr<SurgSim::Framework::Logger> getLogger() const;

    boost::mutex m_componentMutex;

    std::vector<std::shared_ptr<Component>> m_componentAdditions;
    std::vector<std::shared_ptr<Component>> m_componentRemovals;
    std::vector<std::shared_ptr<SceneElement>> m_elementCache;

    // Each behavior will have a type to be matched with the corresponding manager
    // Managers will only handle matching behaviors
    std::vector<std::shared_ptr<SurgSim::Framework::Behavior>> m_behaviors;

    void doBeforeStop() override;

    template<class T>
    void retireComponents(const std::vector<std::shared_ptr<T>>& container);

private:
    virtual bool executeAdditions(const std::shared_ptr<Component>& component) = 0;

    virtual bool executeRemovals(const std::shared_ptr<Component>& component) = 0;

    bool executeInitialization() override;

    void removeComponents(const std::vector<std::shared_ptr<Component>>::const_iterator& beginIt,
                          const std::vector<std::shared_ptr<Component>>::const_iterator& endIt);

    void addComponents(
        const std::vector<std::shared_ptr<Component>>::const_iterator& beginIt,
        const std::vector<std::shared_ptr<Component>>::const_iterator& endIt,
        std::vector<std::shared_ptr<Component>>* actualAdditions);

    void wakeUpComponents(const std::vector<std::shared_ptr<Component>>::const_iterator& beginIt,
                          const std::vector<std::shared_ptr<Component>>::const_iterator& endIt);

    std::weak_ptr<Runtime> m_runtime;
};

}; // namespace Framework
}; // namespace SurgSim

#include "SurgSim/Framework/ComponentManager-inl.h"

#endif // SURGSIM_FRAMEWORK_COMPONENTMANAGER_H