PhantomDevice.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_DEVICES_PHANTOM_PHANTOMDEVICE_H
#define SURGSIM_DEVICES_PHANTOM_PHANTOMDEVICE_H

#include <memory>
#include <string>

#include "SurgSim/Input/CommonDevice.h"

namespace SurgSim
{
namespace Devices
{
class PhantomScaffold;

SURGSIM_STATIC_REGISTRATION(PhantomDevice);

class PhantomDevice : public SurgSim::Input::CommonDevice
{
public:
    explicit PhantomDevice(const std::string& uniqueName);

    SURGSIM_CLASSNAME(SurgSim::Devices::PhantomDevice);

    virtual ~PhantomDevice();

    void setInitializationName(const std::string& initializationName);

    std::string getInitializationName() const;

    bool initialize() override;

    bool isInitialized() const override;

private:
    friend class PhantomScaffold;

    bool finalize() override;

    std::shared_ptr<PhantomScaffold> m_scaffold;
    std::string m_initializationName;
};

};  // namespace Devices
};  // namespace SurgSim

#endif  // SURGSIM_DEVICES_PHANTOM_PHANTOMDEVICE_H