DeviceInterface.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_INPUT_DEVICEINTERFACE_H
#define SURGSIM_INPUT_DEVICEINTERFACE_H

#include <memory>
#include <string>

#include "SurgSim/Input/InputConsumerInterface.h"
#include "SurgSim/Input/OutputProducerInterface.h"
#include "SurgSim/Framework/Accessible.h"
#include "SurgSim/Framework/ObjectFactory.h"

namespace SurgSim
{
namespace Input
{


class DeviceInterface : public Framework::Accessible, public Framework::FactoryBase1<DeviceInterface, std::string>
{
public:
    virtual ~DeviceInterface()
    {
    }

    virtual std::string getName() const = 0;

    virtual std::string getClassName() const = 0;

    virtual bool initialize() = 0;

    virtual bool isInitialized() const = 0;

    virtual bool addInputConsumer(std::shared_ptr<InputConsumerInterface> inputConsumer) = 0;

    virtual bool removeInputConsumer(std::shared_ptr<InputConsumerInterface> inputConsumer) = 0;

    virtual void clearInputConsumers() = 0;

    virtual bool setOutputProducer(std::shared_ptr<OutputProducerInterface> outputProducer) = 0;

    virtual bool removeOutputProducer(std::shared_ptr<OutputProducerInterface> outputProducer) = 0;

    virtual bool hasOutputProducer() = 0;

    virtual void clearOutputProducer() = 0;

private:
    virtual bool finalize() = 0;
};


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

#endif // SURGSIM_INPUT_DEVICEINTERFACE_H