doc/sdk/_pv_stream_g_e_v_8h_source.html

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

 #ifndef __PVSTREAMGEV_H__
 #define __PVSTREAMGEV_H__

 #ifndef EBUS_ENUM
 #define EBUS_ENUM(x) typedef enum
 #endif

 #include <PvStream.h>


 EBUS_ENUM(PvDataReceiverType)
 {
     PvDataReceiverTypeUnknown = -1,
     PvDataReceiverTypeEBusDriver = 0,
     PvDataReceiverTypeUserMode = 1,
     PvDataReceiverTypeTCP = 2

 } PvDataReceiverType;


 class PV_STREAM_API PvStreamGEV : public PvStream
 {
 public:

     PvStreamGEV();

     virtual ~PvStreamGEV();

     PvResult Open( const PvDeviceInfo *aDeviceInfo );

     PvResult Open( const PvDeviceInfo *aDeviceInfo, uint16_t aLocalPort, uint16_t aChannel = 0, const PvString & aLocalIpAddress = PvString(), uint32_t aBuffersCapacity = 64 );

     PvResult Open( const PvDeviceInfo *aDeviceInfo, const PvString & aMulticastAddr, uint16_t aDataPort, uint16_t aChannel = 0, const PvString & aLocalIPAddress = PvString(), uint32_t aBuffersCapacity = 64 );

     PvResult Open( const PvString &aInfo );

     PvResult Open( const PvString &aInfo, uint16_t aLocalPort, uint16_t aChannel = 0, const PvString & aLocalIpAddress = PvString(), uint32_t aBuffersCapacity = 64 );

     PvResult Open( const PvString &aInfo, const PvString & aMulticastAddr, uint16_t aDataPort, uint16_t aChannel = 0, const PvString & aLocalIPAddress = PvString(), uint32_t aBuffersCapacity = 64 );

     virtual PvStreamType GetType() const;

     PvDataReceiverType GetDataReceiverType() const;

     PvResult FlushPacketQueue();

     bool GetWaitForFirstPacketOfBlockToStart() const;

     PvResult SetWaitForFirstPacketOfBlockToStart( bool aWaitForFirstPacketOfBlockToStart );

     uint16_t GetLocalPort() const;

     PvString GetLocalIPAddress() const;

     PvString GetMulticastIPAddress() const;

     PvString GetDeviceIPAddress() const;

     uint16_t GetSpecificLocalPort() const;

     uint32_t GetUserModeDataReceiverThreadPriority() const;

     PvResult SetUserModeDataReceiverThreadPriority( uint32_t aPriority );

     PvResult GetUserModeSocketRxBufferSize( uint32_t &aBufferSize );

     PvResult SetUserModeSocketRxBufferSize( uint32_t aSize );

     PvResult SetUserModeRxPacketBufferSize( uint32_t aSize );

     static PvResult IsDriverInstalled( PvString &aIPAddress, bool &aInstalled, const PvString & aLocalIPAddress = PvString() );

 protected:

 private:

      // Not implemented
     PvStreamGEV( const PvStreamGEV & );
     const PvStreamGEV &operator=( const PvStreamGEV & );


 };

 #endif
PvStream
Receive data from a GigE Vision or USB3 Vision transmitter.
Definition: PvStream.h:50

PvStreamGEV
Receive data from a GigE Vision.
Definition: PvStreamGEV.h:34

PvString
String class.
Definition: PvString.h:25

PvResult
Result information.
Definition: PvResult.h:29

PvStream::GetType
virtual PvStreamType GetType() const
Returns whether the object is a GigE Vision or USB3 Vision stream receiver.
Definition: PvStream.cpp:206

PvDeviceInfo
Information identifying a device.
Definition: PvDeviceInfo.h:26