C++ API
Loading...
Searching...
No Matches
plux.h File Reference
#include <map>
#include <string>
#include <vector>
#include <time.h>

Go to the source code of this file.

Classes

struct  Plux::DevInfo
 Information about a device found by BaseDev::findDevices(). More...
 
class  Plux::Variant
 This class encapsulates a value of one of following data types: bool, int, float and String. More...
 
class  Plux::Exception
 Generic PLUX C++ API exception. More...
 
class  Plux::NotifException
 Base class for all notification exceptions. More...
 
class  Plux::Notification::OpeningPort
 Exception thrown if there was a problem while opening the communication port. More...
 
class  Plux::Notification::InitializingPort
 Exception thrown if there was a problem while initializing the communication port. More...
 
class  Plux::Notification::AdapterNotFound
 Exception thrown if no Bluetooth adapter was found while trying to connect to a Bluetooth device. More...
 
class  Plux::Notification::DeviceNotFound
 Exception thrown if the requested device path was not found. More...
 
class  Plux::Notification::ContactingDevice
 Exception thrown if the connection with the device was lost. More...
 
class  Plux::ErrorException
 Base class for all error exceptions. More...
 
class  Plux::Error::InvalidParameter
 Exception thrown if a method call has an invalid parameter value. More...
 
class  Plux::Error::InvalidOperation
 Exception thrown if the requested operation cannot be completed due to current device state. More...
 
class  Plux::Error::NotSupported
 Exception thrown if the requested operation is not supported by the device. More...
 
class  Plux::Error::InvalidInstance
 Exception thrown if an invalid object instance method was called. More...
 
class  Plux::Error::MissingModule
 Exception thrown if an API module is missing or invalid (DLL or .so file). More...
 
struct  Plux::Clock
 Event timestamp class. More...
 
struct  Plux::Event
 Event base class. More...
 
struct  Plux::EvtDigInUpdate
 Digital port input change event class. More...
 
struct  Plux::EvtSchedChange
 Session schedule change event class. More...
 
struct  Plux::EvtSync
 Synchronization event class. More...
 
struct  Plux::EvtGestFeatures
 Gesture features event class. More...
 
struct  Plux::EvtDisconnect
 Device disconnect event class. More...
 
struct  Plux::EvtSignalGood
 Sensor signal good event class. More...
 
struct  Plux::EvtBattery
 Battery state event class. More...
 
struct  Plux::EvtSensorTrack
 Sensor connection/disconnection tracking event class. More...
 
struct  Plux::EvtFrameData
 
struct  Plux::EvtDeviceState
 Device state change event class. More...
 
struct  Plux::EvtCalibrationData
 
class  Plux::BaseDev
 Base class for all PLUX devices. More...
 
struct  Plux::Sensor
 Sensor information class. More...
 
struct  Plux::Source
 Acquisition source class. More...
 
class  Plux::SignalsDev
 Base class for PLUX signal-acquiring devices. More...
 
struct  Plux::Schedule
 Session schedule class. More...
 
struct  Plux::SessionSource
 Saved acquisition source class with sensor information. More...
 
struct  Plux::Session
 Stored session header class. More...
 
class  Plux::MemoryDev
 Base class for PLUX signal-acquiring devices with internal memory. More...
 
class  Plux::BITalinoDev
 Base class for Plux BITalino devices. More...
 
struct  Plux::BITalinoDev::State
 Current device state returned by BITalinoDev::getState() More...
 
class  Plux::StimDev
 This class is not covered in this documentation. More...
 

Namespaces

namespace  Plux
 The PLUX C++ API namespace.
 
namespace  Plux::Notification
 Namespace for all notification exceptions.
 
namespace  Plux::Error
 Namespace for all error exceptions.
 

Macros

#define PLUX_API_VERSION   "1.11"
 Current API version string.
 
#define PLUX_API_BUILD_DATE   __DATE__
 Compile API date.
 
#define DEBUG_MSG(msg)
 
#define DEBUG_PRINT(fmt, ...)
 

Typedefs

typedef std::string Plux::String
 String type.
 
typedef std::vector< int > Plux::Ints
 Vector of int type.
 
typedef std::vector< bool > Plux::Bools
 Vector of bool type.
 
typedef std::vector< DevInfoPlux::DevInfos
 Vector of DevInfo type.
 
typedef std::map< String, VariantPlux::Properties
 Map from String keywords to Variant types.
 
typedef std::map< int, SensorPlux::Sensors
 Map of sensor port indexes to Sensor information.
 
typedef std::vector< SourcePlux::Sources
 Vector of Source type.
 
typedef std::vector< SchedulePlux::Schedules
 Vector of Schedule type.
 
typedef std::vector< SessionSourcePlux::SessionSources
 Vector of SessionSource type.
 
typedef std::vector< SessionPlux::Sessions
 Vector of Session type.
 

Detailed Description

Version
1.8
Date
December 2019

Macro Definition Documentation

◆ DEBUG_MSG

#define DEBUG_MSG (   msg)
Value:
fprintf(stderr, "[DEBUG]>> %s (%s:%d - %s)\n", msg, \
__FILE__, \
__LINE__, \
__FUNCTION__);

◆ DEBUG_PRINT

#define DEBUG_PRINT (   fmt,
  ... 
)
Value:
fprintf(stderr, "[DEBUG]>> " fmt " (%s:%d %s())\n", ##__VA_ARGS__, \
__FILE__, \
__LINE__, \
__FUNCTION__);