SixenseScaffold.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_SIXENSE_SIXENSESCAFFOLD_H
#define SURGSIM_DEVICES_SIXENSE_SIXENSESCAFFOLD_H

#include <memory>

#include "SurgSim/Framework/Logger.h"
#include "SurgSim/DataStructures/DataGroup.h"

namespace SurgSim
{
namespace Devices
{

class SixenseDevice;
class SixenseThread;

class SixenseScaffold
{
public:
    ~SixenseScaffold();

    static std::shared_ptr<SixenseScaffold> getOrCreateSharedInstance();

private:
    struct StateData;
    struct DeviceData;

    friend class SixenseDevice;
    friend class SixenseThread;
    friend struct StateData;

    SixenseScaffold();

    bool registerDevice(SixenseDevice* device);

    bool unregisterDevice(const SixenseDevice* device);

    bool runInputFrame();

    bool updateDevice(const DeviceData& info);

    bool initializeSdk();

    bool finalizeSdk();

    bool findUnusedDeviceAndRegister(SixenseDevice* device, int* numUsedDevicesSeen, bool* fatalError);

    bool registerIfUnused(int baseIndex, int controllerIndex, SixenseDevice* device, int* numUsedDevicesSeen);

    bool createThread();

    bool destroyThread();

    static SurgSim::DataStructures::DataGroup buildDeviceInputData();



    std::shared_ptr<SurgSim::Framework::Logger> m_logger;
    std::unique_ptr<StateData> m_state;

    static int m_startupDelayMilliseconds;
    static int m_startupRetryIntervalMilliseconds;
};

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

#endif  // SURGSIM_DEVICES_SIXENSE_SIXENSESCAFFOLD_H