CommonDevice.h

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

#include <memory>
#include <string>

#include "SurgSim/Input/DeviceInterface.h"
#include "SurgSim/DataStructures/DataGroup.h"

namespace SurgSim
{
namespace Input
{

class InputConsumerInterface;
class OutputProducerInterface;

class CommonDevice : public DeviceInterface
{
public:
    explicit CommonDevice(const std::string& name);

    CommonDevice(const std::string& name, const DataStructures::DataGroup& inputData);

    CommonDevice(const std::string& name, DataStructures::DataGroup&& inputData);

    virtual ~CommonDevice();

    std::string getName() const override;

    std::string getClassName() const override;

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

    std::string getNameForCallback() const;

    bool addInputConsumer(std::shared_ptr<InputConsumerInterface> inputConsumer) override;

    bool removeInputConsumer(std::shared_ptr<InputConsumerInterface> inputConsumer) override;

    void clearInputConsumers() override;

    bool setOutputProducer(std::shared_ptr<OutputProducerInterface> outputProducer) override;

    bool removeOutputProducer(std::shared_ptr<OutputProducerInterface> outputProducer) override;

    bool hasOutputProducer() override;

    void clearOutputProducer() override;

protected:

    virtual void pushInput();

    virtual bool pullOutput();

    DataStructures::DataGroup& getInputData();

    const DataStructures::DataGroup& getOutputData() const;

private:
    struct State;

    const std::string m_name;

    std::string m_nameForCallback;

    DataStructures::DataGroup m_inputData;

    DataStructures::DataGroup m_outputData;

    std::vector<std::weak_ptr<InputConsumerInterface>> m_inputConsumerList;

    std::weak_ptr<OutputProducerInterface> m_outputProducer;

    boost::mutex m_consumerProducerMutex;

};


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

#endif // SURGSIM_INPUT_COMMONDEVICE_H