gForceSDK
gfTypes.h File Reference

The basic type definitions using in gForceSDK. More...

#include <iostream>
#include <string>
#include <memory>

Go to the source code of this file.

Namespaces

 gf
 The namespace in which all of the gForceSDK project definitions are contained.
 

Macros

#define _T(x)   x
 ANSI/UNICODE convenience.
 

Typedefs

typedef char gf::GF_CHAR
 type definition
 
typedef char * gf::GF_PCHAR
 type definition
 
typedef const char * gf::GF_CPCHAR
 type definition
 
typedef unsigned int gf::GF_UINT
 type definition
 
typedef int gf::GF_INT
 type definition
 
typedef float gf::GF_FLOAT
 type definition
 
typedef unsigned char gf::GF_UINT8
 type definition
 
typedef unsigned char * gf::GF_PUINT8
 type definition
 
typedef unsigned short gf::GF_UINT16
 type definition
 
typedef unsigned short * gf::GF_PUINT16
 type definition
 
typedef unsigned int gf::GF_UINT32
 type definition
 
typedef unsigned long long gf::GF_UINT64
 type definition
 
typedef size_t gf::GF_SIZE
 type definition
 
typedef GF_INT gf::GF_STATUS
 type definition
 
typedef void * gf::GF_HANDLE
 type definition
 
using gf::tstring = std::string
 std::string type definition for ANSI/UNICODE convenience
 
typedef char gf::tchar
 char type definition for ANSI/UNICODE convenience
 
template<typename T >
using gf::gfwPtr = std::weak_ptr< T >
 The weak pointer.
 
template<typename T >
using gf::gfsPtr = std::shared_ptr< T >
 The strong pointer.
 
using gf::WPDEVICE = gfwPtr< Device >
 the weak pointer to Device
 
using gf::SPDEVICE = gfsPtr< Device >
 the strong pointer to Device
 

Enumerations

enum  gf::WorkMode { gf::WorkMode::Freerun, gf::WorkMode::Polling }
 Defines how callbacks are called in threads. More...
 
enum  gf::GF_RET_CODE : GF_UINT32 {
  gf::GF_RET_CODE::GF_SUCCESS = 0, gf::GF_RET_CODE::GF_ERROR, gf::GF_RET_CODE::GF_ERROR_BAD_PARAM, gf::GF_RET_CODE::GF_ERROR_BAD_STATE,
  gf::GF_RET_CODE::GF_ERROR_NOT_SUPPORT, gf::GF_RET_CODE::GF_ERROR_SCAN_BUSY, gf::GF_RET_CODE::GF_ERROR_NO_RESOURCE, gf::GF_RET_CODE::GF_ERROR_TIMEOUT,
  gf::GF_RET_CODE::GF_ERROR_DEVICE_BUSY, gf::GF_RET_CODE::GF_ERROR_NOT_READY
}
 Defines possible return values of methods. More...
 
enum  gf::Gesture : GF_UINT8 {
  Relax = 0x00, Fist = 0x01, SpreadFingers = 0x02, WaveIn = 0x03,
  WaveOut = 0x04, Pinch = 0x05, Shoot = 0x06, UserDefine1 = 0x07,
  UserDefine2 = 0x08, UserDefine3 = 0x09, UserDefine4 = 0x0A, UserDefine5 = 0x0B,
  UserDefine6 = 0x0C, UserDefine7 = 0x0D, UserDefine8 = 0x0E, UserDefine9 = 0x0F,
  Undefined = 0xFF
}
 Gesture types predefined in the gForce device.
 
enum  gf::DeviceStatus : GF_UINT8 {
  None = 0, ReCenter = 1, UsbPlugged = 2, UsbPulled = 3,
  Motionless = 4
}
 Device status notification of a gForce device.
 
enum  gf::HubState {
  Idle, Scanning, Connecting, Disconnected,
  Unknown
}
 Possible Hub states.
 
enum  gf::DeviceConnectionStatus { Disconnected, Disconnecting, Connecting, Connected }
 Possible gForce device connection status.
 
enum  gf::DeviceDataType : GF_UINT32 {
  DDT_INVALID = 0, DDT_ACCELERATE, DDT_GYROSCOPE, DDT_MAGNETOMETER,
  DDT_EULERANGLE, DDT_QUATERNION, DDT_ROTATIONMATRIX, DDT_GESTURE,
  DDT_EMGRAW, DDT_HIDMOUSE, DDT_HIDJOYSTICK, DDT_DEVICESTATUS,
  DDT_MAX
}
 Define the data types the device do support.
 
enum  gf::ProfileCharType : GF_UINT8 {
  PROF_SIMPLE_DATA = 0, PROF_DATA_CMD, PROF_DATA_NTF, PROF_OAD_IDENTIFY,
  PROF_OAD_BLOCK, PROF_OAD_FAST
}
 Define the gforce profile characteristic type.
 

Detailed Description

The basic type definitions using in gForceSDK.

Version
0.1
Date
2017.4.3