FileSinkPlugin Class Reference

#include <filesinkplugin.h>

Inheritance diagram for FileSinkPlugin:

Collaboration diagram for FileSinkPlugin:

Public Member Functions
	FileSinkPlugin (QObject *parent=NULL)
const PluginDescriptor &	getPluginDescriptor () const
void	initPlugin (PluginAPI *pluginAPI)
virtual SamplingDevices	enumSampleSinks ()
virtual PluginInstanceGUI *	createSampleSinkPluginInstanceGUI (const QString &sinkId, QWidget **widget, DeviceUISet *deviceUISet)
virtual DeviceSampleSink *	createSampleSinkPluginInstance (const QString &sinkId, DeviceAPI *deviceAPI)
Public Member Functions inherited from PluginInterface
virtual	~PluginInterface ()
virtual PluginInstanceGUI *	createRxChannelGUI (DeviceUISet *deviceUISet, BasebandSampleSink *rxChannel)
virtual BasebandSampleSink *	createRxChannelBS (DeviceAPI *deviceAPI)
virtual ChannelAPI *	createRxChannelCS (DeviceAPI *deviceAPI)
virtual PluginInstanceGUI *	createTxChannelGUI (DeviceUISet *deviceUISet, BasebandSampleSource *txChannel)
virtual BasebandSampleSource *	createTxChannelBS (DeviceAPI *deviceAPI)
virtual ChannelAPI *	createTxChannelCS (DeviceAPI *deviceAPI)
virtual SamplingDevices	enumSampleSources ()
virtual PluginInstanceGUI *	createSampleSourcePluginInstanceGUI (const QString &sourceId, QWidget **widget, DeviceUISet *deviceUISet)
virtual DeviceSampleSource *	createSampleSourcePluginInstance (const QString &sourceId, DeviceAPI *deviceAPI)
virtual void	deleteSampleSourcePluginInstanceGUI (PluginInstanceGUI *ui)
virtual void	deleteSampleSourcePluginInstanceInput (DeviceSampleSource *source)
virtual void	deleteSampleSinkPluginInstanceGUI (PluginInstanceGUI *ui)
virtual void	deleteSampleSinkPluginInstanceOutput (DeviceSampleSink *sink)
virtual SamplingDevices	enumSampleMIMO ()
virtual PluginInstanceGUI *	createSampleMIMOPluginInstanceGUI (const QString &mimoId, QWidget **widget, DeviceUISet *deviceUISet)
virtual DeviceSampleMIMO *	createSampleMIMOPluginInstance (const QString &mimoId, DeviceAPI *deviceAPI)
virtual void	deleteSampleMIMOPluginInstanceGUI (PluginInstanceGUI *ui)
virtual void	deleteSampleMIMOPluginInstanceMIMO (DeviceSampleMIMO *mimo)

Static Public Attributes
static const QString	m_hardwareID = "FileSink"
static const QString	m_deviceTypeID = FILESINK_DEVICE_TYPE_ID

Static Private Attributes
static const PluginDescriptor	m_pluginDescriptor

Additional Inherited Members
Public Types inherited from PluginInterface
typedef QList< SamplingDevice >	SamplingDevices

Detailed Description

Definition at line 29 of file filesinkplugin.h.

Constructor & Destructor Documentation

FileSinkPlugin()

FileSinkPlugin::FileSinkPlugin ( QObject *  parent = NULL )

explicit

Definition at line 42 of file filesinkplugin.cpp.

                                              :
    QObject(parent)
{
}

Member Function Documentation

createSampleSinkPluginInstance()

DeviceSampleSink * FileSinkPlugin::createSampleSinkPluginInstance ( const QString &  sinkId, DeviceAPI *  deviceAPI  )

virtual

Reimplemented from PluginInterface.

Definition at line 105 of file filesinkplugin.cpp.

References m_deviceTypeID.

{
    if(sinkId == m_deviceTypeID)
    {
        FileSinkOutput* output = new FileSinkOutput(deviceAPI);
        return output;
    }
    else
    {
        return 0;
    }

}

createSampleSinkPluginInstanceGUI()

PluginInstanceGUI * FileSinkPlugin::createSampleSinkPluginInstanceGUI ( const QString &  sinkId, QWidget **  widget, DeviceUISet *  deviceUISet  )

virtual

Reimplemented from PluginInterface.

Definition at line 87 of file filesinkplugin.cpp.

References m_deviceTypeID.

Referenced by enumSampleSinks().

{
    if(sinkId == m_deviceTypeID)
    {
        FileSinkGui* gui = new FileSinkGui(deviceUISet);
        *widget = gui;
        return gui;
    }
    else
    {
        return 0;
    }
}

Here is the caller graph for this function:

enumSampleSinks()

PluginInterface::SamplingDevices FileSinkPlugin::enumSampleSinks ( )

virtual

Reimplemented from PluginInterface.

Definition at line 57 of file filesinkplugin.cpp.

References PluginInterface::SamplingDevice::BuiltInDevice, createSampleSinkPluginInstanceGUI(), m_deviceTypeID, m_hardwareID, and PluginInterface::SamplingDevice::StreamSingleTx.

{
    SamplingDevices result;

    result.append(SamplingDevice(
            "FileSink",
            m_hardwareID,
            m_deviceTypeID,
            QString::null,
            0,
            PluginInterface::SamplingDevice::BuiltInDevice,
            PluginInterface::SamplingDevice::StreamSingleTx,
            1,
            0));

    return result;
}

Here is the call graph for this function:

getPluginDescriptor()

const PluginDescriptor & FileSinkPlugin::getPluginDescriptor ( ) const

virtual

Implements PluginInterface.

Definition at line 47 of file filesinkplugin.cpp.

References m_pluginDescriptor.

{
    return m_pluginDescriptor;
}

initPlugin()

void FileSinkPlugin::initPlugin ( PluginAPI *  pluginAPI )

virtual

Implements PluginInterface.

Definition at line 52 of file filesinkplugin.cpp.

References m_deviceTypeID, and PluginAPI::registerSampleSink().

{
    pluginAPI->registerSampleSink(m_deviceTypeID, this);
}

Here is the call graph for this function:

Member Data Documentation

m_deviceTypeID

const QString FileSinkPlugin::m_deviceTypeID = FILESINK_DEVICE_TYPE_ID

static

Definition at line 48 of file filesinkplugin.h.

Referenced by createSampleSinkPluginInstance(), createSampleSinkPluginInstanceGUI(), enumSampleSinks(), and initPlugin().

m_hardwareID

const QString FileSinkPlugin::m_hardwareID = "FileSink"

static

Definition at line 47 of file filesinkplugin.h.

Referenced by enumSampleSinks().

m_pluginDescriptor

const PluginDescriptor FileSinkPlugin::m_pluginDescriptor

staticprivate

Initial value:

= {
    QString("File sink output"),
    QString("4.2.1"),
    QString("(c) Edouard Griffiths, F4EXB"),
    QString("https://github.com/f4exb/sdrangel"),
    true,
    QString("https://github.com/f4exb/sdrangel")
}

Definition at line 51 of file filesinkplugin.h.

Referenced by getPluginDescriptor().

---

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

• plugins/samplesink/filesink/filesinkplugin.h
• plugins/samplesink/filesink/filesinkplugin.cpp