SDRAngel: PluginInterface::SamplingDevice Struct Reference

SDRAngel 4.11.5

Developer docs for <a href="https://github.com/f4exb/sdrangel">SDRangel<\a>, an Open Source Qt5 / OpenGL 3.0+ SDR and signal analyzer frontend to various hardware.

#include <plugininterface.h>

Public Types
enum	SamplingDeviceType { PhysicalDevice, BuiltInDevice }

enum	StreamType { StreamSingleRx, StreamSingleTx, StreamMIMO }

Public Member Functions
	SamplingDevice (const QString &_displayedName, const QString &_hardwareId, const QString &_id, const QString &_serial, int _sequence, SamplingDeviceType _type, StreamType _streamType, int _deviceNbItems, int _deviceItemIndex)

Public Attributes
QString	displayedName
	The human readable name. More...

QString	hardwareId
	The internal id that identifies the type of hardware (i.e. HackRF, BladeRF, ...) More...

QString	id
	The internal plugin ID corresponding to the device (i.e. for HackRF input, for HackRF output ...) More...

QString	serial
	The device serial number defined by the vendor or a fake one (SDRplay) More...

int	sequence
	The device sequence. >0 when more than one device of the same type is connected. More...

SamplingDeviceType	type
	The sampling device type for behavior information. More...

StreamType	streamType
	This is the type of stream supported. More...

int	deviceNbItems
	Number of items (or streams) in the device. >1 for composite devices. More...

int	deviceItemIndex
	For composite devices this is the Rx or Tx stream index. -1 if not initialized. More...

int	claimed
	This is the device set index if claimed else -1. More...

Detailed Description

Definition at line 33 of file plugininterface.h.

Member Enumeration Documentation

◆ SamplingDeviceType

enum PluginInterface::SamplingDevice::SamplingDeviceType

Enumerator
PhysicalDevice
BuiltInDevice

Definition at line 35 of file plugininterface.h.

         {
             PhysicalDevice,
             BuiltInDevice
         };

◆ StreamType

enum PluginInterface::SamplingDevice::StreamType

Enumerator
StreamSingleRx	Exposes a single input stream that can be one of the streams of a physical device.
StreamSingleTx	Exposes a single output stream that can be one of the streams of a physical device.
StreamMIMO	May expose any number of input and/or output streams.

Definition at line 41 of file plugininterface.h.

         {
             StreamSingleRx, 
             StreamSingleTx, 
             StreamMIMO      
         };

Constructor & Destructor Documentation

◆ SamplingDevice()

PluginInterface::SamplingDevice::SamplingDevice	(	const QString &	_displayedName,
		const QString &	_hardwareId,
		const QString &	_id,
		const QString &	_serial,
		int	_sequence,
		SamplingDeviceType	_type,
		StreamType	_streamType,
		int	_deviceNbItems,
		int	_deviceItemIndex
	)

inline

Definition at line 59 of file plugininterface.h.

                                       :
             displayedName(_displayedName),
             hardwareId(_hardwareId),
             id(_id),
             serial(_serial),
             sequence(_sequence),
             type(_type),
             streamType(_streamType),
             deviceNbItems(_deviceNbItems),
             deviceItemIndex(_deviceItemIndex),
             claimed(-1)
         { }

Member Data Documentation

◆ claimed

int PluginInterface::SamplingDevice::claimed

This is the device set index if claimed else -1.

Definition at line 57 of file plugininterface.h.

Referenced by WebAPIAdapterGUI::instanceDevices(), and WebAPIAdapterSrv::instanceDevices().

◆ deviceItemIndex

int PluginInterface::SamplingDevice::deviceItemIndex

For composite devices this is the Rx or Tx stream index. -1 if not initialized.

Definition at line 56 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), WebAPIAdapterGUI::devicesetDevicePut(), WebAPIAdapterSrv::devicesetDevicePut(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), and MainWindow::sampleSourceChanged().

◆ deviceNbItems

int PluginInterface::SamplingDevice::deviceNbItems

Number of items (or streams) in the device. >1 for composite devices.

Definition at line 55 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), WebAPIAdapterGUI::devicesetDevicePut(), WebAPIAdapterSrv::devicesetDevicePut(), WebAPIAdapterGUI::instanceDevices(), WebAPIAdapterSrv::instanceDevices(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), and MainWindow::sampleSourceChanged().

◆ displayedName

QString PluginInterface::SamplingDevice::displayedName

The human readable name.

Definition at line 48 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), WebAPIAdapterGUI::devicesetDevicePut(), WebAPIAdapterSrv::devicesetDevicePut(), WebAPIAdapterGUI::instanceDevices(), WebAPIAdapterSrv::instanceDevices(), DeviceUserArgsDialog::pushHWDeviceReference(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), MainWindow::sampleSourceChanged(), and SamplingDeviceControl::setSelectedDeviceIndex().

◆ hardwareId

QString PluginInterface::SamplingDevice::hardwareId

The internal id that identifies the type of hardware (i.e. HackRF, BladeRF, ...)

Definition at line 49 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), WebAPIAdapterGUI::devicesetDevicePut(), WebAPIAdapterSrv::devicesetDevicePut(), WebAPIAdapterGUI::instanceDevices(), WebAPIAdapterSrv::instanceDevices(), DeviceUserArgsDialog::pushHWDeviceReference(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), and MainWindow::sampleSourceChanged().

◆ id

QString PluginInterface::SamplingDevice::id

The internal plugin ID corresponding to the device (i.e. for HackRF input, for HackRF output ...)

Definition at line 50 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), and MainWindow::sampleSourceChanged().

◆ sequence

int PluginInterface::SamplingDevice::sequence

The device sequence. >0 when more than one device of the same type is connected.

Definition at line 52 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), WebAPIAdapterGUI::devicesetDevicePut(), WebAPIAdapterSrv::devicesetDevicePut(), WebAPIAdapterGUI::instanceDevices(), WebAPIAdapterSrv::instanceDevices(), DeviceUserArgsDialog::pushHWDeviceReference(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), and MainWindow::sampleSourceChanged().

◆ serial

QString PluginInterface::SamplingDevice::serial

The device serial number defined by the vendor or a fake one (SDRplay)

Definition at line 51 of file plugininterface.h.

Referenced by MainWindow::addMIMODevice(), MainCore::addSinkDevice(), MainWindow::addSinkDevice(), MainCore::addSourceDevice(), MainWindow::addSourceDevice(), MainCore::changeSampleSink(), MainCore::changeSampleSource(), WebAPIAdapterGUI::devicesetDevicePut(), WebAPIAdapterSrv::devicesetDevicePut(), WebAPIAdapterGUI::instanceDevices(), WebAPIAdapterSrv::instanceDevices(), MainWindow::sampleMIMOChanged(), MainWindow::sampleSinkChanged(), and MainWindow::sampleSourceChanged().

◆ streamType

StreamType PluginInterface::SamplingDevice::streamType

This is the type of stream supported.

Definition at line 54 of file plugininterface.h.

Referenced by WebAPIAdapterGUI::instanceDevices(), and WebAPIAdapterSrv::instanceDevices().

◆ type

SamplingDeviceType PluginInterface::SamplingDevice::type

The sampling device type for behavior information.

Definition at line 53 of file plugininterface.h.

The documentation for this struct was generated from the following file:

sdrbase/plugin/plugininterface.h