doc/sdk/_pv_device_adapter_8h_source.html

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

 #ifndef __PVDEVICEADAPTER_H__
 #define __PVDEVICEADAPTER_H__

 #include <IPvDeviceAdapter.h>
 #include <PvDevice.h>


 class IPvDeviceEventSinkList;

 namespace PtUtilsLib
 {
     class Mutex;
 }

 class PV_DEVICE_API PvDeviceAdapter : public IPvDeviceAdapter, PvDeviceEventSink, PvGenEventSink
 {
 public:

     PvDeviceAdapter( PvDevice *aDevice );

     virtual ~PvDeviceAdapter();

     bool IsGenIntegerInNodeMap( const PvString &aParameterName );

     bool IsGenEnumInNodeMap( const PvString &aParameterName );

     bool IsGenBooleanInNodeMap( const PvString &aParameterName );

     bool IsGenRegisterInNodeMap( const PvString &aParameterName );

     bool IsGenReadable( const PvString &aParameterName );

     bool IsGenWritable( const PvString &aParameterName );

     bool IsGenEnumEntryAvailable( const PvString &aParameterName, const PvString &aEnumEntry );

     PvResult GetGenIntegerValue( const PvString &aParameterName, int64_t &aValue );

     PvResult GetGenEnumEntriesAvailable( const PvString &aParameterName, PvStringList &aList );

     PvResult GetGenEnumValue( const PvString &aParameterName, PvString &aEnumEntry );

     PvResult SetGenEnumValue( const PvString &aParameterName, const PvString &aEnumEntry );

     PvResult GetGenBooleanValue( const PvString &aParameterName, bool &aValue );

     PvResult SetGenBooleanValue( const PvString &aParameterName, bool aValue );

     PvResult GetGenStringValue( const PvString &aParameterName, PvString &aValue );

     PvResult GetGenRegisterLength( const PvString &aParameterName, int64_t &aLength );

     PvResult GetGenRegisterData( const PvString &aParameterName, uint8_t *aDataBuffer, int64_t aByteCount );

     PvResult SetGenRegisterData( const PvString &aParameterName, const uint8_t *aDataBuffer, int64_t aByteCount );

     PvResult RegisterGenInvalidator( const PvString &aParameterName );

     PvResult UnregisterGenInvalidator( const PvString &aParameterName );

     PvResult WriteRegister( int64_t aAddress, uint32_t aValue );

     PvResult ReadRegister( int64_t aAddress, uint32_t &aValue );

     PvResult WriteMemory( const uint8_t *aBuffer, int64_t aAddress, int64_t aLength );

     PvResult ReadMemory( uint8_t *aBuffer, int64_t aAddress, int64_t aLength );

     PvResult WaitForMessagingChannelIdle( uint32_t aTimeout );

     bool IsConnected();

     bool IsPleoraPowered();

     bool IsGigEVision();

     bool IsUSB3Vision();

     PvResult RegisterEventSink( IPvDeviceEventSink *aEventSink );

     PvResult UnregisterEventSink( IPvDeviceEventSink *aEventSink );

     PvResult GetUniqueID( PvString &aID );

 protected:

     void OnEvent( PvDevice *aDevice,
         uint16_t aEventID, uint16_t aChannel, uint64_t aBlockID, uint64_t aTimestamp,
         const void *aData, uint32_t aDataLength );

     void OnParameterUpdate( PvGenParameter *aParameter );

 private:

     PvDevice *mDevice;

     IPvDeviceEventSinkList *mEventSinkList;
     PtUtilsLib::Mutex *mEventSinkListMutex;

 };

 #endif
PvString
String class.
Definition: PvString.h:25

PvResult
Result information.
Definition: PvResult.h:29

IPvDeviceEventSink
Interface used by a class implementing IPvDeviceAdapter to forward notifications to PvDeviceSerialPor...
Definition: IPvDeviceEventSink.h:26

PtUtilsLib
Definition: PvDeviceAdapter.h:16

PvStringList
Class used to hold a group of PvString objects.
Definition: PvStringList.h:19

PvGenEventSink
Observer interface for an observable PvGenParameter object.
Definition: PvGenParameter.h:517

PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:43

PvDeviceAdapter
IPvDeviceAdapter default implementation for the eBUS SDK.
Definition: PvDeviceAdapter.h:31

IPvDeviceAdapter
Interface used by PvDeviceSerialPort to interact with a device controller.
Definition: IPvDeviceAdapter.h:48

PvDeviceEventSink
Observer interface for an observable PvDevice object.
Definition: PvDeviceEventSink.h:65

PvDevice
Connect, configure and control a GigE Vision or USB3 Vision device.
Definition: PvDevice.h:41