DeviceFilter.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_DEVICEFILTERS_DEVICEFILTER_H
#define SURGSIM_DEVICES_DEVICEFILTERS_DEVICEFILTER_H

#include <string>

#include "SurgSim/Input/CommonDevice.h"
#include "SurgSim/Input/InputConsumerInterface.h"
#include "SurgSim/Input/OutputProducerInterface.h"

namespace SurgSim
{
namespace DataStructures
{
class DataGroup;
}

namespace Devices
{

class DeviceFilter :
    public Input::CommonDevice, public Input::InputConsumerInterface, public Input::OutputProducerInterface
{
public:
    explicit DeviceFilter(const std::string& name);

    SURGSIM_CLASSNAME(SurgSim::Devices::DeviceFilter);

    bool initialize() override;

    bool isInitialized() const override;

    void initializeInput(const std::string& device, const DataStructures::DataGroup& inputData) override;

    void handleInput(const std::string& device, const DataStructures::DataGroup& inputData) override;

    bool requestOutput(const std::string& device, DataStructures::DataGroup* outputData) override;

protected:
    virtual void filterInput(const std::string& device, const DataStructures::DataGroup& dataToFilter,
        DataStructures::DataGroup* result);

    virtual void filterOutput(const std::string& device, const DataStructures::DataGroup& dataToFilter,
        DataStructures::DataGroup* result);

protected:
    bool finalize() override;

    bool m_initialized;
};

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

#endif  // SURGSIM_DEVICES_DEVICEFILTERS_DEVICEFILTER_H