Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvDeviceAdapter Class Reference

IPvDeviceAdapter default implementation for the eBUS SDK. More...

Public Member Functions

 PvDeviceAdapter (PvDevice *aDevice)
 Constructor. More...
 
virtual ~PvDeviceAdapter ()
 Destructor.
 
bool IsGenIntegerInNodeMap (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
bool IsGenEnumInNodeMap (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
bool IsGenBooleanInNodeMap (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
bool IsGenRegisterInNodeMap (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
bool IsGenReadable (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
bool IsGenWritable (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
bool IsGenEnumEntryAvailable (const PvString &aParameterName, const PvString &aEnumEntry)
 See IPvDeviceAdapter for description. More...
 
PvResult GetGenIntegerValue (const PvString &aParameterName, int64_t &aValue)
 See IPvDeviceAdapter for description. More...
 
PvResult GetGenEnumEntriesAvailable (const PvString &aParameterName, PvStringList &aList)
 See IPvDeviceAdapter for description. More...
 
PvResult GetGenEnumValue (const PvString &aParameterName, PvString &aEnumEntry)
 See IPvDeviceAdapter for description. More...
 
PvResult SetGenEnumValue (const PvString &aParameterName, const PvString &aEnumEntry)
 See IPvDeviceAdapter for description. More...
 
PvResult GetGenBooleanValue (const PvString &aParameterName, bool &aValue)
 See IPvDeviceAdapter for description. More...
 
PvResult SetGenBooleanValue (const PvString &aParameterName, bool aValue)
 See IPvDeviceAdapter for description. More...
 
PvResult GetGenStringValue (const PvString &aParameterName, PvString &aValue)
 Returns the string value of string parameter identified by its name. More...
 
PvResult GetGenRegisterLength (const PvString &aParameterName, int64_t &aLength)
 See IPvDeviceAdapter for description. More...
 
PvResult GetGenRegisterData (const PvString &aParameterName, uint8_t *aDataBuffer, int64_t aByteCount)
 See IPvDeviceAdapter for description. More...
 
PvResult SetGenRegisterData (const PvString &aParameterName, const uint8_t *aDataBuffer, int64_t aByteCount)
 See IPvDeviceAdapter for description. More...
 
PvResult RegisterGenInvalidator (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
PvResult UnregisterGenInvalidator (const PvString &aParameterName)
 See IPvDeviceAdapter for description. More...
 
PvResult WriteRegister (int64_t aAddress, uint32_t aValue)
 See IPvDeviceAdapter for description. More...
 
PvResult ReadRegister (int64_t aAddress, uint32_t &aValue)
 See IPvDeviceAdapter for description. More...
 
PvResult WriteMemory (const uint8_t *aBuffer, int64_t aAddress, int64_t aLength)
 See IPvDeviceAdapter for description. More...
 
PvResult ReadMemory (uint8_t *aBuffer, int64_t aAddress, int64_t aLength)
 See IPvDeviceAdapter for description. More...
 
PvResult WaitForMessagingChannelIdle (uint32_t aTimeout)
 See IPvDeviceAdapter for description. More...
 
bool IsConnected ()
 See IPvDeviceAdapter for description. More...
 
bool IsPleoraPowered ()
 See IPvDeviceAdapter for description. More...
 
bool IsGigEVision ()
 See IPvDeviceAdapter for description. More...
 
bool IsUSB3Vision ()
 See IPvDeviceAdapter for description. More...
 
PvResult RegisterEventSink (IPvDeviceEventSink *aEventSink)
 See IPvDeviceAdapter for description. More...
 
PvResult UnregisterEventSink (IPvDeviceEventSink *aEventSink)
 See IPvDeviceAdapter for description. More...
 
PvResult GetUniqueID (PvString &aID)
 Returns a unique string identifier for the device. More...
 

Protected Member Functions

void OnEvent (PvDevice *aDevice, uint16_t aEventID, uint16_t aChannel, uint64_t aBlockID, uint64_t aTimestamp, const void *aData, uint32_t aDataLength)
 PvDeviceEventSink callback from PvDevice. More...
 
void OnParameterUpdate (PvGenParameter *aParameter)
 PvGenParameter callback for GenICam parameters invalidators. More...
 

Detailed Description

IPvDeviceAdapter default implementation for the eBUS SDK.

The IPvDeviceAdapter interface can be implemented for any SDK that can control GigE Vision and/or USB3 Vision devices in order to use PvDeviceSerialPort.

PvDeviceAdapter provides a default implementation of the IPvDeviceAdapter that can be used with the eBUS SDK.

Constructor & Destructor Documentation

◆ PvDeviceAdapter()

PvDeviceAdapter::PvDeviceAdapter ( PvDevice aDevice)

Constructor.

Parameters
[in]aDeviceA device.

Member Function Documentation

◆ GetGenBooleanValue()

PvResult PvDeviceAdapter::GetGenBooleanValue ( const PvString aParameterName,
bool &  aValue 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[out]aValueValue of the parameter.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetGenEnumEntriesAvailable()

PvResult PvDeviceAdapter::GetGenEnumEntriesAvailable ( const PvString aParameterName,
PvStringList aList 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[out]aListA list containing the string representation of all available enum entries.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetGenEnumValue()

PvResult PvDeviceAdapter::GetGenEnumValue ( const PvString aParameterName,
PvString aEnumEntry 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[out]aEnumEntryValue of the parameter.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetGenIntegerValue()

PvResult PvDeviceAdapter::GetGenIntegerValue ( const PvString aParameterName,
int64_t &  aValue 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[out]aValueValue of the parameter.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetGenRegisterData()

PvResult PvDeviceAdapter::GetGenRegisterData ( const PvString aParameterName,
uint8_t *  aDataBuffer,
int64_t  aByteCount 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[out]aDataBufferBuffer where to copy the data.
[in]aByteCountHow many bytes to copy to aDataBuffer.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetGenRegisterLength()

PvResult PvDeviceAdapter::GetGenRegisterLength ( const PvString aParameterName,
int64_t &  aLength 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[in]aLengthLength (in bytes) of the register.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetGenStringValue()

PvResult PvDeviceAdapter::GetGenStringValue ( const PvString aParameterName,
PvString aValue 
)
virtual

Returns the string value of string parameter identified by its name.

Parameters
[in]aParameterNameName of the parameter.
[out]aValueValue of the parameter.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ GetUniqueID()

PvResult PvDeviceAdapter::GetUniqueID ( PvString aID)
virtual

Returns a unique string identifier for the device.

Parameters
[out]aIDUnique string identifier for the device.
Returns
Includes:

Implements IPvDeviceAdapter.

◆ IsConnected()

bool PvDeviceAdapter::IsConnected ( )
virtual

See IPvDeviceAdapter for description.

Returns
True if the device is connected, false if not.

Implements IPvDeviceAdapter.

◆ IsGenBooleanInNodeMap()

bool PvDeviceAdapter::IsGenBooleanInNodeMap ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
Returns
True if the parameter is present, false if not.

Implements IPvDeviceAdapter.

◆ IsGenEnumEntryAvailable()

bool PvDeviceAdapter::IsGenEnumEntryAvailable ( const PvString aParameterName,
const PvString aEnumEntry 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
[in]aEnumEntryName of the enum entry to test for.
Returns
True if the parameter is present and contains the specific enum entry, false if either condition fails.

Implements IPvDeviceAdapter.

◆ IsGenEnumInNodeMap()

bool PvDeviceAdapter::IsGenEnumInNodeMap ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
Returns
True if the parameter is present, false if not.

Implements IPvDeviceAdapter.

◆ IsGenIntegerInNodeMap()

bool PvDeviceAdapter::IsGenIntegerInNodeMap ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
Returns
True if the parameter is present, false if not.

Implements IPvDeviceAdapter.

◆ IsGenReadable()

bool PvDeviceAdapter::IsGenReadable ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
Returns
True if the parameter is present and readable, false if either condition fails.

Implements IPvDeviceAdapter.

◆ IsGenRegisterInNodeMap()

bool PvDeviceAdapter::IsGenRegisterInNodeMap ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
Returns
True if the parameter is present, false if not.

Implements IPvDeviceAdapter.

◆ IsGenWritable()

bool PvDeviceAdapter::IsGenWritable ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter to test for.
Returns
True if the parameter is present and writable, false if either condition fails.

Implements IPvDeviceAdapter.

◆ IsGigEVision()

bool PvDeviceAdapter::IsGigEVision ( )
virtual

See IPvDeviceAdapter for description.

Returns
True if using the GigE Vision protocol, false if not.

Implements IPvDeviceAdapter.

◆ IsPleoraPowered()

bool PvDeviceAdapter::IsPleoraPowered ( )
virtual

See IPvDeviceAdapter for description.

Returns
True if the device runs on a Pleora design, false if not.

Implements IPvDeviceAdapter.

◆ IsUSB3Vision()

bool PvDeviceAdapter::IsUSB3Vision ( )
virtual

See IPvDeviceAdapter for description.

Returns
True if using the USB3 Vision protocol, false if not.

Implements IPvDeviceAdapter.

◆ OnEvent()

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

PvDeviceEventSink callback from PvDevice.

Parameters
[in]aDeviceDevice that triggered the callback.
[in]aEventIDEvent ID.
[in]aChannelChannel of the event.
[in]aBlockIDBlock ID of the event.
[in]aTimestampTimestamp of the event.
[in]aDataData pointer (can be NULL if EVENT_CMD instead of EVENTDATA_CMD)
[in]aDataLengthData Length (can be 0 if EVENT_CMD instead of EVENTDATA_CMD)

Reimplemented from PvDeviceEventSink.

◆ OnParameterUpdate()

void PvDeviceAdapter::OnParameterUpdate ( PvGenParameter aParameter)
protectedvirtual

PvGenParameter callback for GenICam parameters invalidators.

Parameters
[in]aParameterThe invalidated parameter.

Implements PvGenEventSink.

◆ ReadMemory()

PvResult PvDeviceAdapter::ReadMemory ( uint8_t *  aBuffer,
int64_t  aAddress,
int64_t  aLength 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aBufferPointer of the buffer where the data will be written.
[in]aAddressAddress where to read the daa.
[aLength]aLength Length of the data to read, in bytes.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ ReadRegister()

PvResult PvDeviceAdapter::ReadRegister ( int64_t  aAddress,
uint32_t &  aValue 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aAddressAddress of the register.
[out]aValueValue read from the register.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ RegisterEventSink()

PvResult PvDeviceAdapter::RegisterEventSink ( IPvDeviceEventSink aEventSink)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aEventSinkPointer to an object implementing the IPvDeviceEventSink interface.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ RegisterGenInvalidator()

PvResult PvDeviceAdapter::RegisterGenInvalidator ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ SetGenBooleanValue()

PvResult PvDeviceAdapter::SetGenBooleanValue ( const PvString aParameterName,
bool  aValue 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[in]aValueNew value for the enumeration.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ SetGenEnumValue()

PvResult PvDeviceAdapter::SetGenEnumValue ( const PvString aParameterName,
const PvString aEnumEntry 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[in]aEnumEntryNew value for the enumeration.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ SetGenRegisterData()

PvResult PvDeviceAdapter::SetGenRegisterData ( const PvString aParameterName,
const uint8_t *  aDataBuffer,
int64_t  aByteCount 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
[out]aDataBufferBuffer to copy the data from.
[in]aByteCountHow many bytes to copy from aDataBuffer to the register.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ UnregisterEventSink()

PvResult PvDeviceAdapter::UnregisterEventSink ( IPvDeviceEventSink aEventSink)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aEventSinkPointer to an object implementing the IPvDeviceEventSink interface.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ UnregisterGenInvalidator()

PvResult PvDeviceAdapter::UnregisterGenInvalidator ( const PvString aParameterName)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aParameterNameName of the parameter.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ WaitForMessagingChannelIdle()

PvResult PvDeviceAdapter::WaitForMessagingChannelIdle ( uint32_t  aTimeout)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aTimeoutA timeout.
Returns
OK if the messaging channel is idle. TIMEOUT if the timeout elapsed before it becomes idle.

Implements IPvDeviceAdapter.

◆ WriteMemory()

PvResult PvDeviceAdapter::WriteMemory ( const uint8_t *  aBuffer,
int64_t  aAddress,
int64_t  aLength 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aBufferPointer to the data to write.
[in]aAddressAddress where to write the data.
[aLength]aLength Length of the data to write, in bytes.
Returns
OK on success.

Implements IPvDeviceAdapter.

◆ WriteRegister()

PvResult PvDeviceAdapter::WriteRegister ( int64_t  aAddress,
uint32_t  aValue 
)
virtual

See IPvDeviceAdapter for description.

Parameters
[in]aAddressAddress of the register.
[in]aValueValue to write to the register.
Returns
OK on success.

Implements IPvDeviceAdapter.


The documentation for this class was generated from the following files:

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