Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
IPvDeviceAdapter.h
1// *****************************************************************************
2//
3// Copyright (c) 2013, Pleora Technologies Inc., All rights reserved.
4//
5// *****************************************************************************
6
7#ifndef __IPVDEVICEADAPTER_H__
8#define __IPVDEVICEADAPTER_H__
9
10#include <PvTypes.h>
11#include <PvString.h>
12#include <PvResult.h>
13
14#include <PvStringList.h>
15#include <IPvDeviceEventSink.h>
16
17
18// If implementing your own IPvDeviceAdapter, #define PV_CUSTOM_DEVICE_ADAPTER
19// in order to prevent DLL-import of IPvDeviceAdapter
20#if defined( WIN32 ) && !defined( PT_LIB_STATIC ) && !defined( PV_CUSTOM_DEVICE_ADAPTER )
21 #if defined( PV_DEVICE_EXPORTS )
22 #define IPV_DEVICE_ADAPTER_API __declspec( dllexport )
23 #else
24 #define IPV_DEVICE_ADAPTER_API __declspec( dllimport )
25 #endif
26#else
27 #define IPV_DEVICE_ADAPTER_API
28#endif
29
30
48class IPV_DEVICE_ADAPTER_API IPvDeviceAdapter
49{
50public:
51
53 virtual ~IPvDeviceAdapter() {}
54
62 virtual bool IsGenIntegerInNodeMap( const PvString &aParameterName ) = 0;
63
71 virtual bool IsGenEnumInNodeMap( const PvString &aParameterName ) = 0;
72
80 virtual bool IsGenBooleanInNodeMap( const PvString &aParameterName ) = 0;
81
89 virtual bool IsGenRegisterInNodeMap( const PvString &aParameterName ) = 0;
90
98 virtual bool IsGenReadable( const PvString &aParameterName ) = 0;
99
107 virtual bool IsGenWritable( const PvString &aParameterName ) = 0;
108
117 virtual bool IsGenEnumEntryAvailable( const PvString &aParameterName, const PvString &aEnumEntry ) = 0;
118
127 virtual PvResult GetGenIntegerValue( const PvString &aParameterName, int64_t &aValue ) = 0;
128
137 virtual PvResult GetGenEnumEntriesAvailable( const PvString &aParameterName, PvStringList &aList ) = 0;
138
147 virtual PvResult GetGenEnumValue( const PvString &aParameterName, PvString &aEnumEntry ) = 0;
148
157 virtual PvResult SetGenEnumValue( const PvString &aParameterName, const PvString &aEnumEntry ) = 0;
158
167 virtual PvResult GetGenBooleanValue( const PvString &aParameterName, bool &aValue ) = 0;
168
177 virtual PvResult SetGenBooleanValue( const PvString &aParameterName, bool aValue ) = 0;
178
187 virtual PvResult GetGenStringValue( const PvString &aParameterName, PvString &aValue ) = 0;
188
197 virtual PvResult GetGenRegisterLength( const PvString &aParameterName, int64_t &aLength ) = 0;
198
208 virtual PvResult GetGenRegisterData( const PvString &aParameterName, uint8_t *aDataBuffer, int64_t aByteCount ) = 0;
209
219 virtual PvResult SetGenRegisterData( const PvString &aParameterName, const uint8_t *aDataBuffer, int64_t aByteCount ) = 0;
220
228 virtual PvResult RegisterGenInvalidator( const PvString &aParameterName ) = 0;
229
237 virtual PvResult UnregisterGenInvalidator( const PvString &aParameterName ) = 0;
238
250 virtual PvResult WriteRegister( int64_t aAddress, uint32_t aValue ) = 0;
251
263 virtual PvResult ReadRegister( int64_t aAddress, uint32_t &aValue ) = 0;
264
274 virtual PvResult WriteMemory( const uint8_t *aBuffer, int64_t aAddress, int64_t aLength ) = 0;
275
285 virtual PvResult ReadMemory( uint8_t *aBuffer, int64_t aAddress, int64_t aLength ) = 0;
286
294 virtual PvResult WaitForMessagingChannelIdle( uint32_t aTimeout ) = 0;
295
301 virtual bool IsConnected() = 0;
302
308 virtual bool IsPleoraPowered() = 0;
309
315 virtual bool IsGigEVision() = 0;
316
322 virtual bool IsUSB3Vision() = 0;
323
332
341
351 virtual PvResult GetUniqueID( PvString &aID ) = 0;
352
353protected:
354
355private:
356
357};
358
359#endif
Interface used by PvDeviceSerialPort to interact with a device controller.
Definition IPvDeviceAdapter.h:49
virtual bool IsConnected()=0
Returns true if the device is connected.
virtual PvResult GetGenEnumEntriesAvailable(const PvString &aParameterName, PvStringList &aList)=0
Returns a list of all available enum entries for an enumeration.
virtual PvResult GetGenRegisterLength(const PvString &aParameterName, int64_t &aLength)=0
Gets the length (in bytes) of a register identified by its name.
virtual bool IsGenIntegerInNodeMap(const PvString &aParameterName)=0
Returns true if the device node map contains an integer of the specified name.
virtual PvResult GetGenEnumValue(const PvString &aParameterName, PvString &aEnumEntry)=0
Returns the string value of an enumeration identified by its name.
virtual bool IsGigEVision()=0
Returns true if the device uses the GigE Vision protocol.
virtual PvResult RegisterGenInvalidator(const PvString &aParameterName)=0
Registers (and forward to the device serial object) invalidation events for a parameter identified by...
virtual PvResult SetGenEnumValue(const PvString &aParameterName, const PvString &aEnumEntry)=0
Sets the value of an enumeration identified by its name.
virtual bool IsUSB3Vision()=0
Returns true if the device uses the USB3 Vision protocol.
virtual bool IsGenReadable(const PvString &aParameterName)=0
Returns true if a parameter is present and readable in the node map.
virtual PvResult GetGenIntegerValue(const PvString &aParameterName, int64_t &aValue)=0
Returns the value of an integer identified by its name.
virtual PvResult ReadRegister(int64_t aAddress, uint32_t &aValue)=0
Reads a 32 bit value from a GigE Vision register.
virtual bool IsGenWritable(const PvString &aParameterName)=0
Returns true if a parameter is present and writable in the node map.
virtual bool IsGenRegisterInNodeMap(const PvString &aParameterName)=0
Returns true if the device node map contains a raw register of the specified name.
virtual PvResult GetGenStringValue(const PvString &aParameterName, PvString &aValue)=0
Returns the string value of string parameter identified by its name.
virtual PvResult UnregisterEventSink(IPvDeviceEventSink *aEventSink)=0
Unregisters an event sink registered with RegisterEventSink.
virtual bool IsGenEnumEntryAvailable(const PvString &aParameterName, const PvString &aEnumEntry)=0
Returns true if an enumeration is present in the node map and has a specific enum entry.
virtual bool IsPleoraPowered()=0
Returns true if the device runs on a Pleora design.
virtual PvResult GetGenBooleanValue(const PvString &aParameterName, bool &aValue)=0
Returns the value of a Boolean identified by its name.
virtual PvResult WaitForMessagingChannelIdle(uint32_t aTimeout)=0
Waits for the messaging channel queue to be empty.
virtual PvResult RegisterEventSink(IPvDeviceEventSink *aEventSink)=0
Registers an event sink that will want to receive the raw events and GenICam invalidator events.
virtual PvResult GetGenRegisterData(const PvString &aParameterName, uint8_t *aDataBuffer, int64_t aByteCount)=0
Gets the data contained in a register identified by its name.
virtual bool IsGenEnumInNodeMap(const PvString &aParameterName)=0
Returns true if the device node map contains an enumeration of the specified name.
virtual PvResult WriteMemory(const uint8_t *aBuffer, int64_t aAddress, int64_t aLength)=0
Writes data to a the memory of a device.
virtual PvResult GetUniqueID(PvString &aID)=0
Returns a unique string identifier for the device.
virtual PvResult SetGenRegisterData(const PvString &aParameterName, const uint8_t *aDataBuffer, int64_t aByteCount)=0
Sets the data contained in a register identified by its name.
virtual PvResult SetGenBooleanValue(const PvString &aParameterName, bool aValue)=0
Sets the value of a Boolean identified by its name.
virtual PvResult WriteRegister(int64_t aAddress, uint32_t aValue)=0
Writes a 32 bit value to a GigE Vision register.
virtual bool IsGenBooleanInNodeMap(const PvString &aParameterName)=0
Returns true if the device node map contains a Boolean of the specified name.
virtual PvResult UnregisterGenInvalidator(const PvString &aParameterName)=0
Unregisters (and forward to the device serial object) invalidation events for a parameter identified ...
virtual PvResult ReadMemory(uint8_t *aBuffer, int64_t aAddress, int64_t aLength)=0
Reads data from the memory of a device.
Interface used by a class implementing IPvDeviceAdapter to forward notifications to PvDeviceSerialPor...
Definition IPvDeviceEventSink.h:27
Result information.
Definition PvResult.h:30
String class.
Definition PvString.h:26
Class used to hold a group of PvString objects.
Definition PvStringList.h:20

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