Hermes SDK Documentation
Public Types | Public Member Functions | List of all members
LeafInfo Class Reference

#include <LeafInfo.h>

Public Types

enum  DeviceType : int {
  PrimeOneGlove, PrimeTwoGlove, HapticsModule, ApolloLegacyGlove,
  Undefined
}
 

Public Member Functions

 LeafInfo (Hermes::Protocol::Hardware::DeviceLeaf &leaf)
 
int BatteryPercentage ()
 generic get functions for the data, so that the user is not tempted to set values (set batterypercentage 100% for easy recharge, no secret energy loopholes here.)
 
DeviceType DeviceOfType ()
 
std::string Name ()
 
Hermes::Protocol::HandType HandOfType ()
 
std::string Description ()
 
int TransmissionStrength ()
 
FamilyInfo::DeviceFamily Family ()
 returns the family. this is based on the internal Hermes enum. More...
 
std::string FamilyToString ()
 returns the current family as a string More...
 
bool HasHaptics ()
 

Detailed Description

This simplifies some of the logic of our test program so the users have a nicer environment to work with. for anything device specific, they will still need to add logic, but for generic feedback, this willwork fine.

Member Function Documentation

◆ Family()

FamilyInfo::DeviceFamily LeafInfo::Family ( )

returns the family. this is based on the internal Hermes enum.

Returns

◆ FamilyToString()

std::string LeafInfo::FamilyToString ( )

returns the current family as a string

Returns

The documentation for this class was generated from the following files: