Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DOCSDK and version 2.8

...

Function declarationInfo
bool ( * GetEnable )( SensorDevice * self) Ask the Device if it is enabled. Also reports if the device is in continuous mode and number of messages left to receive
bool ( *  SetEnable )(SensorDevice * self, bool continuousMode, uint32_t numberOfMessages)Enable the device and set it to either continuous mode or a specified number of messages. Not all protocols handle non-continuous mode
bool ( *  GetDisable )(SensorDevice * self)Returns true if the device is disabled.
bool ( *  SetDisable )(SensorDevice * self)Disable the device. Messages will stop arriving as soon as the Device processes the request, but Messages already in progress will still arrive as normal.
bool ( *  GetOperationModes )(SensorDevice * self)Gets the current Operating Modes of the Device as two bitmasks.
bool ( *  SetOperationModes )(SensorDevice * self, OperationModes modeMask, OperationModes modeValues)Sets the current Operating Modes of the Device as two bitmasks. Setting the modeMask bit for a specific Mode to 1 changes it to become the corresponding bit in modeValues but setting the bit to 0 does not change it.
bool ( *  GetResolution )(SensorDevice * self)Gets the current Resolution of the Device.
bool ( *  SetResolution )(SensorDevice * self, uint32_t x, bool xIsValid, uint32_t y, bool yIsValid, uint32_t z, bool zIsValid)Sets the current Resolution of the Device.
bool ( *  GetTouchActiveArea )(SensorDevice * self)Gets the current Touch Active Area of the Device.
bool ( *  SetTouchActiveArea )(SensorDevice * self, uint32_t lowerBoundaryX, uint32_t upperBoundaryX, bool xIsValid, bool xIsReversed, uint32_t lowerBoundaryY, uint32_t upperBoundaryY, bool yIsValid, bool yIsReversed)Sets the current Touch Active Area of the Device.
bool ( *  GetDetectedObjectSizeRestriction )(SensorDevice * self)Gets the current Detected Object Size Restriction.
bool ( *  SetDetectedObjectSizeRestriction )(SensorDevice * self, uint32_t minimumSize, uint32_t maximumSize, bool minimumSizeIsValid, bool maximumSizeIsValid)Sets the current Detected Object Size Restriction of the device.
bool ( *  GetNumberOfTrackedObjects )(SensorDevice * self)Get the number of tracked objects.
bool ( *  SetNumberOfTrackedObjects )(SensorDevice * self, uint32_t numberOfTrackedObjects)Set the number of tracked objects.
bool ( * GetFloatingProtection) (SensorDevice * self)Gets the state of Floating Protection.
bool ( * SetFloatingProtection) (SensorDevice * self, bool enabled, bool enabledIsValid, uint32_t time, bool timeIsValid)Sets Floating Protection.
bool ( * GetSnappingFilter) (SensorDevice * self)Gets the state of Snapping Filter.
bool ( * SetSnappingFilter) (SensorDevice * self, bool enabled, bool enabledIsValid, uint32_t leftInner, uint32_t leftOuter, bool leftIsValid, uint32_t rightInner, uint32_t rightOuter, bool rightIsValid, uint32_t topInner, uint32_t topOuter, bool topIsValid, uint32_t bottomInner, uint32_t bottomOuter, bool bottomIsValid)Sets Snapping Filter.
bool ( * GetDoubleClickPrevention) (SensorDevice * self)Gets the state of Double-Click Prevention.
bool ( * SetDoubleClickPrevention) (SensorDevice * self, bool enabled, bool enabledIsValid, uint32_t doubleClickPreventionTime, bool doubleClickPreventionTimeIsValid, uint32_t doubleClickPreventionRadius, bool doubleClickPreventionRadiusIsValid)Sets Double-Click Prevention.

Example

Example of sending GetResolution command to sensor device following by receiving response and destroying message. One for GetResolution and one for SetEnable. 

...