SDK-eBUS/Ubuntu-LTS/eBUS_SDK_JAI_Ubuntu-24.04-x86_64-7.0.1-7536.zip

// *****************************************************************************

//

//     Copyright (c) 2011, Pleora Technologies Inc., All rights reserved.

//

// *****************************************************************************


#ifndef __PVSOFTDEVICEGEV_H__

#define __PVSOFTDEVICEGEV_H__


#include <PvSoftDeviceGEVLib.h>


#include <PvSoftDeviceGEVInterfaces.h>


namespace PvVirtualDeviceLib

{

    class IActionHandler;

}


namespace PvSoftDeviceGEVLib

{

    class SoftDeviceGEV;

}


class IPvUserSetNotify;


class PV_SOFT_DEVICE_GEV_API PvSoftDeviceGEV

    : public IPvSoftDeviceGEV

{

public:


    PvSoftDeviceGEV();


    virtual ~PvSoftDeviceGEV();


    IPvVirtualDeviceGEVInfo *GetInfo() override;


    PvResult AddStream( IPvSWStreamingChannelSource * aSource ) override;


    PvResult SetUserSetCount( uint32_t aCount ) override;


    PvResult SetUserSetNotify( IPvUserSetNotify *aUserSetNotify ) override;


    PvResult SetTCPTransportEnabled( bool aEnabled ) override;


    PvResult SetRTPProtocolEnabled( bool aEnabled ) override;


    PvResult SetStreamTimestamping( bool aEnabled ); // [MG] NEEDS TO OVERRIDE SOMEWHERE...


    PvResult SetActionHandler( PvVirtualDeviceLib::IActionHandler *aActionHandler ) override;


    IPvRegisterMap *GetRegisterMap() override;


    PvResult Start( const PvString &aMACAddress ) override;


    PvResult Stop() override;


    IPvVirtualDeviceGEVStatistics *GetStatistics() override;


    IPvMessageChannel *GetMessagingChannel() override;


    PvResult RegisterEventSink( IPvVirtualDeviceGEVEventSink *aEventSink ) override;


    PvResult UnregisterEventSink( IPvVirtualDeviceGEVEventSink *aEventSink ) override;


    PvResult GetGenICamXMLFile( PvString &aString ) const override;


    // Todo docs. Turns on/off genDC streaming mode on the transmitter

    PvResult SetGenDCEnabled( bool aEnabled ) override;

protected:


    uint32_t GetStreamCount() const;


private:


    PvSoftDeviceGEVLib::SoftDeviceGEV *mThis;


};


#endif

IPvMessageChannel
Messaging channel interface of the software-based GigE Vision Device.
Definition PvVirtualDeviceGEVInterfaces.h:538

IPvRegisterMap
Register map interface for a software-based GigE Vision Device.
Definition PvVirtualDeviceGEVInterfaces.h:1910

IPvSWStreamingChannelSource
Definition PvSoftDeviceGEVInterfaces.h:66

IPvSoftDeviceGEV
Interface to the main class of the software-based GigE Vision Device.
Definition PvSoftDeviceGEVInterfaces.h:265

IPvUserSetNotify
An interface to register a state change callback for UserSets.
Definition IPvUserSetNotify.h:33

IPvVirtualDeviceGEVEventSink
Interface that is used by PvSoftDeviceGEV to report internal events.
Definition PvVirtualDeviceGEVInterfaces.h:631

IPvVirtualDeviceGEVInfo
Interface that is used to customize the identity of a software-based GigE Vision Device.
Definition PvVirtualDeviceGEVInterfaces.h:73

IPvVirtualDeviceGEVStatistics
Interface that is used to retrieve control channel statistics from a software-based GigE Vision Devic...
Definition PvVirtualDeviceGEVInterfaces.h:377

PvResult
Result information.
Definition PvResult.h:30

PvSoftDeviceGEV
Implements a software-based GigE Vision Device with full GVCP and GVSP support.
Definition PvSoftDeviceGEV.h:60

PvSoftDeviceGEV::GetRegisterMap
IPvRegisterMap * GetRegisterMap() override
Obtains the register map interface of the PvSoftDeviceGEV.

PvSoftDeviceGEV::SetTCPTransportEnabled
PvResult SetTCPTransportEnabled(bool aEnabled) override
Enables experimental TCP transport.

PvSoftDeviceGEV::SetGenDCEnabled
PvResult SetGenDCEnabled(bool aEnabled) override
Enables the option of using GenDC for streaming.

PvSoftDeviceGEV::GetStatistics
IPvVirtualDeviceGEVStatistics * GetStatistics() override
Obtains the statistics interface of the PvSoftDeviceGEV.

PvSoftDeviceGEV::Start
PvResult Start(const PvString &aMACAddress) override
Starts the PvSoftDeviceGEV.

PvSoftDeviceGEV::GetGenICamXMLFile
PvResult GetGenICamXMLFile(PvString &aString) const override
Returns the GenICam XML file of the device.

PvSoftDeviceGEV::~PvSoftDeviceGEV
virtual ~PvSoftDeviceGEV()
Destructor.

PvSoftDeviceGEV::GetStreamCount
uint32_t GetStreamCount() const
Get the number of GVSP streams.

PvSoftDeviceGEV::SetActionHandler
PvResult SetActionHandler(PvVirtualDeviceLib::IActionHandler *aActionHandler) override
Sets the action handler for processing action commands.

PvSoftDeviceGEV::AddStream
PvResult AddStream(IPvSWStreamingChannelSource *aSource) override
Adds a new stream to the PvSoftDeviceGEV.

PvSoftDeviceGEV::GetMessagingChannel
IPvMessageChannel * GetMessagingChannel() override
Obtains the messaging channel interface of the PvSoftDeviceGEV.

PvSoftDeviceGEV::PvSoftDeviceGEV
PvSoftDeviceGEV()
Constructor.

PvSoftDeviceGEV::SetStreamTimestamping
PvResult SetStreamTimestamping(bool aEnabled)
Enables stream timestamping on all sources. 'True' by default.

PvSoftDeviceGEV::SetUserSetCount
PvResult SetUserSetCount(uint32_t aCount) override
Sets the number of user-sets supported by the PvSoftDeviceGEV.

PvSoftDeviceGEV::UnregisterEventSink
PvResult UnregisterEventSink(IPvVirtualDeviceGEVEventSink *aEventSink) override
Unregisters a previously registered event sink.

PvSoftDeviceGEV::GetInfo
IPvVirtualDeviceGEVInfo * GetInfo() override
Obtains the information interface of the PvSoftDeviceGEV.

PvSoftDeviceGEV::Stop
PvResult Stop() override
Stops the PvSoftDeviceGEV.

PvSoftDeviceGEV::RegisterEventSink
PvResult RegisterEventSink(IPvVirtualDeviceGEVEventSink *aEventSink) override
Registers an event sink to receive notifications from the PvSoftDeviceGEV.

PvSoftDeviceGEV::SetUserSetNotify
PvResult SetUserSetNotify(IPvUserSetNotify *aUserSetNotify) override
Binds in a class which will contain a callback which will be called when the state of a UsersetLoad/S...

PvSoftDeviceGEV::SetRTPProtocolEnabled
PvResult SetRTPProtocolEnabled(bool aEnabled) override
Enables the option of using RTP for streaming.

PvString
String class.
Definition PvString.h:26