RawMultiAxisThread.h
Go to the documentation of this file.
// 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_MULTIAXIS_RAWMULTIAXISTHREAD_H
#define SURGSIM_DEVICES_MULTIAXIS_RAWMULTIAXISTHREAD_H
#include <memory>
#include <string>
#include "SurgSim/Framework/BasicThread.h"
#include "SurgSim/Devices/MultiAxis/RawMultiAxisScaffold.h"
namespace SurgSim
{
namespace Devices
{
class RawMultiAxisThread : public SurgSim::Framework::BasicThread
{
public:
explicit RawMultiAxisThread(RawMultiAxisScaffold* scaffold, RawMultiAxisScaffold::DeviceData* deviceData);
virtual ~RawMultiAxisThread();
protected:
bool doInitialize() override;
bool doStartUp() override;
bool doUpdate(double dt) override;
void doBeforeStop() override;
private:
RawMultiAxisScaffold* m_scaffold;
RawMultiAxisScaffold::DeviceData* m_deviceData;
};
}; // namespace Devices
}; // namespace SurgSim
#endif // SURGSIM_DEVICES_MULTIAXIS_RAWMULTIAXISTHREAD_H
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::Devices::RawMultiAxisThread
A class implementing the thread context for sampling RawMultiAxis devices.
Definition: RawMultiAxisThread.h:33
SurgSim::Devices::RawMultiAxisThread::doStartUp
bool doStartUp() override
Definition: RawMultiAxisThread.cpp:40
SurgSim::Devices::RawMultiAxisThread::RawMultiAxisThread
RawMultiAxisThread(RawMultiAxisScaffold *scaffold, RawMultiAxisScaffold::DeviceData *deviceData)
Definition: RawMultiAxisThread.cpp:23
SurgSim::Devices::RawMultiAxisScaffold
A class that implements the behavior of RawMultiAxisDevice objects.
Definition: RawMultiAxisScaffold.h:37
SurgSim::Devices::RawMultiAxisThread::doBeforeStop
void doBeforeStop() override
Prepares the thread for its execution to be stopped.
Definition: RawMultiAxisThread.cpp:50
SurgSim::Devices::RawMultiAxisThread::m_deviceData
RawMultiAxisScaffold::DeviceData * m_deviceData
Definition: RawMultiAxisThread.h:48
SurgSim::Devices::RawMultiAxisThread::~RawMultiAxisThread
virtual ~RawMultiAxisThread()
Definition: RawMultiAxisThread.cpp:31
SurgSim::Devices::RawMultiAxisThread::doInitialize
bool doInitialize() override
Definition: RawMultiAxisThread.cpp:35
SurgSim::Devices::RawMultiAxisThread::doUpdate
bool doUpdate(double dt) override
Implementation of actual work function for this thread, this has a default implementation to handle d...
Definition: RawMultiAxisThread.cpp:45
SurgSim::Framework::BasicThread
Basic thread implementation, tries to maintain a constant rate, supplies startup an initialization...
Definition: BasicThread.h:48
SurgSim::Devices::RawMultiAxisScaffold::DeviceData
Definition: RawMultiAxisScaffold.cpp:59
RawMultiAxisScaffold.h
BasicThread.h
SurgSim::Devices::RawMultiAxisThread::m_scaffold
RawMultiAxisScaffold * m_scaffold
Definition: RawMultiAxisThread.h:47