Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



PvSoftDeviceGEV.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2011, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVSOFTDEVICEGEV_H__
8 #define __PVSOFTDEVICEGEV_H__
9 
10 #include <PvSoftDeviceGEVLib.h>
11 
12 #include <PvSoftDeviceGEVInterfaces.h>
13 
14 
15 namespace PvVirtualDeviceLib
16 {
17  class IActionHandler;
18 }
19 
20 namespace PvSoftDeviceGEVLib
21 {
22  class SoftDeviceGEV;
23 }
24 
25 class IPvUserSetNotify;
26 
27 
58 class PV_SOFT_DEVICE_GEV_API PvSoftDeviceGEV
59  : public IPvSoftDeviceGEV
60 {
61 public:
62 
66  PvSoftDeviceGEV();
67 
71  virtual ~PvSoftDeviceGEV();
72 
83  IPvVirtualDeviceGEVInfo *GetInfo() override;
84 
99  PvResult AddStream( IPvSWStreamingChannelSource * aSource ) override;
100 
171  PvResult SetUserSetCount( uint32_t aCount ) override;
172 
181  PvResult SetUserSetNotify( IPvUserSetNotify *aUserSetNotify ) override;
182 
201  PvResult SetTCPTransportEnabled( bool aEnabled ) override;
202 
225  PvResult SetRTPProtocolEnabled( bool aEnabled ) override;
226 
243  PvResult SetStreamTimestamping( bool aEnabled ); // [MG] NEEDS TO OVERRIDE SOMEWHERE...
244 
252  PvResult SetActionHandler( PvVirtualDeviceLib::IActionHandler *aActionHandler ) override;
253 
268  IPvRegisterMap *GetRegisterMap() override;
269 
285  PvResult Start( const PvString &aMACAddress ) override;
286 
295  PvResult Stop() override;
296 
304  IPvVirtualDeviceGEVStatistics *GetStatistics() override;
305 
319  IPvMessageChannel *GetMessagingChannel() override;
320 
335  PvResult RegisterEventSink( IPvVirtualDeviceGEVEventSink *aEventSink ) override;
336 
349  PvResult UnregisterEventSink( IPvVirtualDeviceGEVEventSink *aEventSink ) override;
350 
364  PvResult GetGenICamXMLFile( PvString &aString ) const override;
365 
366  // Todo docs. Turns on/off genDC streaming mode on the transmitter
367  PvResult SetGenDCEnabled( bool aEnabled ) override;
368 protected:
369 
375  uint32_t GetStreamCount() const;
376 
377 private:
378 
379  PvSoftDeviceGEVLib::SoftDeviceGEV *mThis;
380 
381 };
382 
383 
384 #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::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::Start
PvResult Start(const PvString &aMACAddress) override
Starts the PvSoftDeviceGEV.
PvSoftDeviceGEV::GetMessagingChannel
IPvMessageChannel * GetMessagingChannel() override
Obtains the messaging channel interface of 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::PvSoftDeviceGEV
PvSoftDeviceGEV()
Constructor.
PvSoftDeviceGEV::SetStreamTimestamping
PvResult SetStreamTimestamping(bool aEnabled)
Enables stream timestamping on all sources. 'True' by default.
PvSoftDeviceGEV::GetInfo
IPvVirtualDeviceGEVInfo * GetInfo() override
Obtains the information interface of the PvSoftDeviceGEV.
PvSoftDeviceGEV::SetUserSetCount
PvResult SetUserSetCount(uint32_t aCount) override
Sets the number of user-sets supported by the PvSoftDeviceGEV.
PvSoftDeviceGEV::GetStatistics
IPvVirtualDeviceGEVStatistics * GetStatistics() override
Obtains the statistics interface of the PvSoftDeviceGEV.
PvSoftDeviceGEV::UnregisterEventSink
PvResult UnregisterEventSink(IPvVirtualDeviceGEVEventSink *aEventSink) override
Unregisters a previously registered event sink.
PvSoftDeviceGEV::Stop
PvResult Stop() override
Stops the PvSoftDeviceGEV.
PvSoftDeviceGEV::GetRegisterMap
IPvRegisterMap * GetRegisterMap() override
Obtains the register map interface of 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

Copyright (c) 2002-2026 Pleora Technologies Inc.
www.pleora.com