doc/sdk/_pv_device_8h_source.html

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

 //

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

 //

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


 #ifndef __PVDEVICE_H__

 #define __PVDEVICE_H__


 #include <PvDeviceLib.h>

 #include <PvDeviceInfo.h>

 #include <PvGenParameterArray.h>

 #include <PvDeviceEnums.h>

 #include <PvDeviceEventSink.h>


 class PvDeviceEventSink;


 namespace PvDeviceLib

 {

     class Device;

 }


 class PvDeviceEventSink;

 class PvConfigurationWriter;

 class PvConfigurationReader;


 class PV_DEVICE_API PvDevice

 {

 public:

     virtual ~PvDevice();


     static PvDevice *CreateAndConnect( const PvDeviceInfo *aDeviceInfo, PvResult *aResult );


     static PvDevice *CreateAndConnect( const PvString &aInfo, PvResult *aResult );


     static void Free( PvDevice *aDevice );


     PvDeviceType GetType() const;


     virtual PvResult Connect( const PvDeviceInfo *aDeviceInfo );


     virtual PvResult Connect( const PvString &aInfo );


     PvResult Disconnect();


     PvResult StreamEnable( uint32_t aChannel = 0 );


     PvResult StreamDisable( uint32_t aChannel = 0 );


     bool IsConnected() const;


     bool IsPleoraPowered() const;


     PvResult DumpGenICamXML( const PvString &aFilename );


     PvResult GetDefaultGenICamXMLFilename( PvString &aFilename );


     PvGenParameterArray *GetParameters();


     PvGenParameterArray *GetCommunicationParameters();


     PvResult ReadMemory( int64_t aAddress, unsigned char *aDestination, int64_t aByteCount );


     PvResult WriteMemory( int64_t aAddress, const unsigned char *aSource, int64_t aByteCount );


     PvResult WaitForMessagingChannelIdle( uint32_t aTimeout );


     PvResult RegisterEventSink( PvDeviceEventSink *aEventSink );


     PvResult UnregisterEventSink( PvDeviceEventSink *aEventSink );


     uint32_t GetHeartbeatThreadPriority() const;


     PvResult SetHeartbeatThreadPriority( uint32_t aPriority );


     uint32_t GetInterruptLinkThreadPriority() const;


     PvResult SetInterruptLinkThreadPriority( uint32_t aPriority );


     uint32_t GetInterruptQueueThreadPriority() const;


     PvResult SetInterruptQueueThreadPriority( uint32_t aPriority );


     uint32_t GetPayloadSize();


     PvResult GetUniqueID( PvString &aID );


 protected:

     PvDevice();


     PvDeviceLib::Device *mThis;


 private:


     // Not implemented

     PvDevice( const PvDevice & );

     const PvDevice &operator=( const PvDevice & );


 };


 #endif

PvDeviceEnums.h
PvDevice library enumerations.

PvDeviceType
PvDeviceType
Definition: PvSystemEnums.h:75

PvConfigurationReader
Restore the state of the system.
Definition: PvConfigurationReader.h:24

PvConfigurationWriter
Save the state of the system.
Definition: PvConfigurationWriter.h:24

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

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

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

PvGenParameterArray
GenICam feature array.
Definition: PvGenParameterArray.h:73

PvResult
Result information.
Definition: PvResult.h:30

PvString
String class.
Definition: PvString.h:26