Component.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_FRAMEWORK_COMPONENT_H
#define SURGSIM_FRAMEWORK_COMPONENT_H

#include <memory>
#include <string>

#include <boost/uuid/uuid.hpp>

#include "SurgSim/Framework/Accessible.h"
#include "SurgSim/Framework/ObjectFactory.h"

namespace SurgSim
{
namespace Framework
{

// Forward References
class PoseComponent;
class Runtime;
class Scene;
class SceneElement;

class Component :
    public Accessible,
    public std::enable_shared_from_this<Component>,
    public FactoryBase1<Component, std::string>
{
public:
    explicit Component(const std::string& name);
    virtual ~Component();

    std::string getName() const;

    std::string getFullName() const;

    void setName(const std::string& name);

    boost::uuids::uuid getUuid() const;

    bool isInitialized() const;

    bool initialize(const std::weak_ptr<Runtime>& runtime);

    bool isAwake() const;

    bool wakeUp();

    void retire();

    void setScene(std::weak_ptr<Scene> scene);

    std::shared_ptr<Scene> getScene();

    void setSceneElement(std::weak_ptr<SceneElement> sceneElement);

    std::shared_ptr<SceneElement> getSceneElement();

    std::shared_ptr<const SceneElement> getSceneElement() const;

    std::shared_ptr<Runtime> getRuntime() const;

    virtual std::string getClassName() const;

    std::shared_ptr<Component> getSharedPtr();

    virtual bool doInitialize() = 0;

    virtual bool doWakeUp() = 0;

    virtual void doRetire();

    bool isActive() const;

    virtual void setLocalActive(bool val);

    bool isLocalActive() const;

protected:
    virtual std::shared_ptr<PoseComponent> getPoseComponent();

    virtual std::shared_ptr<const PoseComponent> getPoseComponent() const;


private:


    std::string m_name;

    boost::uuids::uuid m_uuid;

    std::weak_ptr<Runtime> m_runtime;

    std::weak_ptr<Scene> m_scene;

    std::weak_ptr<SceneElement> m_sceneElement;

    bool m_didInit;

    bool m_didWakeUp;

    bool m_isInitialized;

    bool m_isAwake;

    bool m_isLocalActive;

};

template <class Target, class Source>
std::shared_ptr<Target> checkAndConvert(std::shared_ptr<Source> incoming, const std::string& expectedTypeName);

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

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

#endif // SURGSIM_FRAMEWORK_COMPONENT_H