reference

This documentation is automatically generated from the openFrameworks source code using doxygen and refers to the most recent release, version 0.12.0.

ofSerialDeviceInfo Class Reference

Describes a Serial device, including ID, name and path. More...

#include <ofSerial.h>

Public Member Functions

 ofSerialDeviceInfo (std::string devicePathIn, std::string deviceNameIn, int deviceIDIn)
 Construct an ofSerialDeviceInfo with parameters.
 
 ofSerialDeviceInfo ()
 Construct an undefined serial device.
 
std::string getDevicePath ()
 Gets the path to the device.
 
std::string getDeviceName ()
 Gets the name of the device.
 
int getDeviceID ()
 Gets the ID of the device.
 

Friends

class ofSerial
 

Detailed Description

Describes a Serial device, including ID, name and path.

Constructor & Destructor Documentation

◆ ofSerialDeviceInfo() [1/2]

ofSerialDeviceInfo::ofSerialDeviceInfo ( std::string  devicePathIn,
std::string  deviceNameIn,
int  deviceIDIn 
)
inline

Construct an ofSerialDeviceInfo with parameters.

Parameters
devicePathInThe path to the device.
deviceNameInThe name of the device.
deviceIDInThe ID of the device.

◆ ofSerialDeviceInfo() [2/2]

ofSerialDeviceInfo::ofSerialDeviceInfo ( )
inline

Construct an undefined serial device.

Member Function Documentation

◆ getDeviceID()

int ofSerialDeviceInfo::getDeviceID ( )
inline

Gets the ID of the device.

Example: 0,1,2,3 etc.

Returns
the device ID.

◆ getDeviceName()

std::string ofSerialDeviceInfo::getDeviceName ( )
inline

Gets the name of the device.

Example: usbdevice-a440 or COM4.

Returns
the device name.

◆ getDevicePath()

std::string ofSerialDeviceInfo::getDevicePath ( )
inline

Gets the path to the device.

Example: /dev/tty.cu/usbdevice-a440.

Returns
the device path.

Friends And Related Symbol Documentation

◆ ofSerial

friend class ofSerial
friend

The documentation for this class was generated from the following file:
  • /Users/icq4ever/Desktop/oF0120/libs/openFrameworks/communication/ofSerial.h