Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



PvSoftDeviceGEVInterfaces.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2011, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVSOFTDEVICEGEVINTERFACES_H__
8 #define __PVSOFTDEVICEGEVINTERFACES_H__
9 
10 #include <PvVirtualDeviceGEVInterfaces.h>
11 #include <PvSoftDeviceGEVLib.h>
12 #include <PvBuffer.h>
13 
14 
64 class PV_SOFT_DEVICE_GEV_API IPvSWStreamingChannelSource
65  : public IPvStreamingChannelSource
66 {
67 public:
68 
72  virtual ~IPvSWStreamingChannelSource() {}
73 
94  virtual PvBuffer* AllocBuffer() = 0;
95 
104  virtual void FreeBuffer( PvBuffer* aBuffer ) = 0;
105 
134  virtual PvResult GetTxNumBuffersToUse( uint32_t &aNumBuffer ) = 0;
135 
136 
151  virtual PvResult QueueBuffer( PvBuffer* aBuffer ) = 0;
152 
160  virtual bool PreQueueBufferProc() { return true; }
161 
167  virtual void PostRetrieveBufferProc() {}
168 
189  virtual PvResult RetrieveBuffer( PvBuffer **aBuffer ) = 0;
190 
200  virtual void AbortQueuedBuffers() = 0;
201 };
202 
203 
211 class PV_SOFT_DEVICE_GEV_API IPvSWStreamingChannelSourceGenDC
212  : public IPvSWStreamingChannelSource
213 {
214 public:
224  virtual void AssignGenDCManager( IPvGenDCManager* aManager ) = 0;
225 
233  virtual void SetupGenDCContainer() = 0;
234 
240  virtual bool GetGenDCStreamingMode() const = 0;
241 
252  virtual PvResult SetGenDCStreamingMode( bool aEnabled ) = 0;
253 
254 protected:
255  IPvGenDCManager* mGDCManager;
256 
257 };
258 
263 class PV_SOFT_DEVICE_GEV_API IPvSoftDeviceGEV
264  : public IPvVirtualDeviceGEV
265 {
266 public:
267 
271  ~IPvSoftDeviceGEV() {}
272 
287  virtual PvResult AddStream( IPvSWStreamingChannelSource* aSource ) = 0;
288 
307  virtual PvResult SetTCPTransportEnabled( bool aEnabled ) = 0;
308 
331  virtual PvResult SetRTPProtocolEnabled( bool aEnabled ) = 0;
332 
333 
340  virtual PvResult SetGenDCEnabled( bool aEnabled ) = 0;
341 
342 };
343 
344 #endif // __PVSOFTDEVICEGEVINTERFACES_H__
IPvGenDCManager
Interface for managing GenDC (Generic Data Container) operations.
Definition: PvGenDCInterfaces.h:265
IPvSWStreamingChannelSourceGenDC
Streaming channel source interface with GenDC (Generic Data Container) support.
Definition: PvSoftDeviceGEVInterfaces.h:213
IPvSWStreamingChannelSourceGenDC::SetupGenDCContainer
virtual void SetupGenDCContainer()=0
Sets up the GenDC container before device initialization.
IPvSWStreamingChannelSourceGenDC::SetGenDCStreamingMode
virtual PvResult SetGenDCStreamingMode(bool aEnabled)=0
Enables or disables GenDC streaming mode.
IPvSWStreamingChannelSourceGenDC::GetGenDCStreamingMode
virtual bool GetGenDCStreamingMode() const =0
Gets the current GenDC streaming mode state.
IPvSWStreamingChannelSourceGenDC::AssignGenDCManager
virtual void AssignGenDCManager(IPvGenDCManager *aManager)=0
Assigns the GenDC manager to the streaming channel source.
IPvSWStreamingChannelSource
Definition: PvSoftDeviceGEVInterfaces.h:66
IPvSWStreamingChannelSource::QueueBuffer
virtual PvResult QueueBuffer(PvBuffer *aBuffer)=0
Request by the PvSoftDeviceGEV to queue a buffer for acquisition.
IPvSWStreamingChannelSource::AbortQueuedBuffers
virtual void AbortQueuedBuffers()=0
Request by the PvSoftDeviceGEV to abort all buffers queued for acquisition.
IPvSWStreamingChannelSource::~IPvSWStreamingChannelSource
virtual ~IPvSWStreamingChannelSource()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:72
IPvSWStreamingChannelSource::RetrieveBuffer
virtual PvResult RetrieveBuffer(PvBuffer **aBuffer)=0
Request by the PvSoftDeviceGEV to retrieve a buffer from the streaming source.
IPvSWStreamingChannelSource::FreeBuffer
virtual void FreeBuffer(PvBuffer *aBuffer)=0
Request by the PvSoftDeviceGEV to free or release a buffer allocated with AllocBuffer.
IPvSWStreamingChannelSource::AllocBuffer
virtual PvBuffer * AllocBuffer()=0
Request by the PvSoftDeviceGEV to allocate a PvBuffer.
IPvSWStreamingChannelSource::GetTxNumBuffersToUse
virtual PvResult GetTxNumBuffersToUse(uint32_t &aNumBuffer)=0
This method is requested by PvSoftDeviceGEV to limit the number of buffers used by the transmitter....
IPvSoftDeviceGEV
Interface to the main class of the software-based GigE Vision Device.
Definition: PvSoftDeviceGEVInterfaces.h:265
IPvSoftDeviceGEV::~IPvSoftDeviceGEV
~IPvSoftDeviceGEV()
Virtual destructor.
Definition: PvSoftDeviceGEVInterfaces.h:271
IPvSoftDeviceGEV::AddStream
virtual PvResult AddStream(IPvSWStreamingChannelSource *aSource)=0
Adds a new stream to the PvSoftDeviceGEV.
IPvSoftDeviceGEV::SetGenDCEnabled
virtual PvResult SetGenDCEnabled(bool aEnabled)=0
Enables the option of using GenDC for streaming.
IPvSoftDeviceGEV::SetTCPTransportEnabled
virtual PvResult SetTCPTransportEnabled(bool aEnabled)=0
Enables experimental TCP transport.
IPvSoftDeviceGEV::SetRTPProtocolEnabled
virtual PvResult SetRTPProtocolEnabled(bool aEnabled)=0
Enables the option of using RTP for streaming.
IPvStreamingChannelSource
Interface that is used by PvSoftDeviceGEV to query and report information from a streaming source imp...
Definition: PvVirtualDeviceGEVInterfaces.h:804
IPvVirtualDeviceGEV
Interface to the main class of the software-based GigE Vision Device.
Definition: PvVirtualDeviceGEVInterfaces.h:2929
PvBuffer
Represents a block of GigE Vision or USB3 Vision data in memory.
Definition: PvBuffer.h:111
PvResult
Result information.
Definition: PvResult.h:30

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