SurgSim::Devices::KeyboardScaffold::DeviceData Struct Reference

Struct to hold a KeyboardDevice object, a KeyboardHandler object, and a mutex for data passing. More...

## Public Member Functions

| DeviceData (KeyboardDevice *device)
| Constructor. More...

## Public Attributes

KeyboardDevice *const | deviceObject
| Device object managed by this scaffold. More...
osg::ref_ptr< OsgKeyboardHandler > | keyboardHandler
| Keyboard Handler to communicate with underneath API. More...
boost::mutex | mutex
| The mutex that protects the externally modifiable parameters. More...

## Private Member Functions

| DeviceData (const DeviceData &)
DeviceData & | operator= (const DeviceData &)

## Detailed Description

Struct to hold a KeyboardDevice object, a KeyboardHandler object, and a mutex for data passing.

## Constructor & Destructor Documentation

## DeviceData() [1/2]

SurgSim::Devices::KeyboardScaffold::DeviceData::DeviceData | ( | KeyboardDevice * | device | ) |

inline explicit

Constructor.

Parameters

  device | Device to be managed by this scaffold

## DeviceData() [2/2]

SurgSim::Devices::KeyboardScaffold::DeviceData::DeviceData | ( | const DeviceData & |  | ) |

private

## Member Function Documentation

## operator=()

DeviceData& SurgSim::Devices::KeyboardScaffold::DeviceData::operator= | ( | const DeviceData & |  | ) |

private

## Member Data Documentation

## deviceObject

KeyboardDevice* const SurgSim::Devices::KeyboardScaffold::DeviceData::deviceObject

Device object managed by this scaffold.

## keyboardHandler

osg::ref_ptr<OsgKeyboardHandler> SurgSim::Devices::KeyboardScaffold::DeviceData::keyboardHandler

Keyboard Handler to communicate with underneath API.

## mutex

boost::mutex SurgSim::Devices::KeyboardScaffold::DeviceData::mutex

The mutex that protects the externally modifiable parameters.

The documentation for this struct was generated from the following file:

- SurgSim/Devices/Keyboard/KeyboardScaffold.cpp