Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvDeviceAdapter Class Referenceabstract

Interface used by PvDeviceSerialPort to interact with a device controller. More...

Public Member Functions

virtual bool IsGenIntegerInNodeMap (const PvString &aParameterName)=0
 Returns true if the device node map contains an integer of the specified name. More...
 
virtual bool IsGenEnumInNodeMap (const PvString &aParameterName)=0
 Returns true if the device node map contains an enumeration of the specified name. More...
 
virtual bool IsGenBooleanInNodeMap (const PvString &aParameterName)=0
 Returns true if the device node map contains a Boolean of the specified name. More...
 
virtual bool IsGenRegisterInNodeMap (const PvString &aParameterName)=0
 Returns true if the device node map contains a raw register of the specified name. More...
 
virtual bool IsGenReadable (const PvString &aParameterName)=0
 Returns true if a parameter is present and readable in the node map. More...
 
virtual bool IsGenWritable (const PvString &aParameterName)=0
 Returns true if a parameter is present and writable in the node map. More...
 
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. More...
 
virtual PvResult GetGenIntegerValue (const PvString &aParameterName, int64_t &aValue)=0
 Returns the value of an integer identified by its name. More...
 
virtual PvResult GetGenEnumEntriesAvailable (const PvString &aParameterName, PvStringList &aList)=0
 Returns a list of all available enum entries for an enumeration. More...
 
virtual PvResult GetGenEnumValue (const PvString &aParameterName, PvString &aEnumEntry)=0
 Returns the string value of an enumeration identified by its name. More...
 
virtual PvResult SetGenEnumValue (const PvString &aParameterName, const PvString &aEnumEntry)=0
 Sets the value of an enumeration identified by its name. More...
 
virtual PvResult GetGenBooleanValue (const PvString &aParameterName, bool &aValue)=0
 Returns the value of a Boolean identified by its name. More...
 
virtual PvResult SetGenBooleanValue (const PvString &aParameterName, bool aValue)=0
 Sets the value of a Boolean identified by its name. More...
 
virtual PvResult GetGenStringValue (const PvString &aParameterName, PvString &aValue)=0
 Returns the string value of string parameter identified by its name. More...
 
virtual PvResult GetGenRegisterLength (const PvString &aParameterName, int64_t &aLength)=0
 Gets the length (in bytes) of a register identified by its name. More...
 
virtual PvResult GetGenRegisterData (const PvString &aParameterName, uint8_t *aDataBuffer, int64_t aByteCount)=0
 Gets the data contained in a register identified by its name. More...
 
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. More...
 
virtual PvResult RegisterGenInvalidator (const PvString &aParameterName)=0
 Registers (and forward to the device serial object) invalidation events for a parameter identified by its name. More...
 
virtual PvResult UnregisterGenInvalidator (const PvString &aParameterName)=0
 Unregisters (and forward to the device serial object) invalidation events for a parameter identified by its name. More...
 
virtual PvResult WriteRegister (int64_t aAddress, uint32_t aValue)=0
 Writes a 32 bit value to a GigE Vision register. More...
 
virtual PvResult ReadRegister (int64_t aAddress, uint32_t &aValue)=0
 Reads a 32 bit value from a GigE Vision register. More...
 
virtual PvResult WriteMemory (const uint8_t *aBuffer, int64_t aAddress, int64_t aLength)=0
 Writes data to a the memory of a device. More...
 
virtual PvResult ReadMemory (uint8_t *aBuffer, int64_t aAddress, int64_t aLength)=0
 Reads data from the memory of a device. More...
 
virtual PvResult WaitForMessagingChannelIdle (uint32_t aTimeout)=0
 Waits for the messaging channel queue to be empty. More...
 
virtual bool IsConnected ()=0
 Returns true if the device is connected. More...
 
virtual bool IsPleoraPowered ()=0
 Returns true if the device runs on a Pleora design. More...
 
virtual bool IsGigEVision ()=0
 Returns true if the device uses the GigE Vision protocol. More...
 
virtual bool IsUSB3Vision ()=0
 Returns true if the device uses the USB3 Vision protocol. More...
 
virtual PvResult RegisterEventSink (IPvDeviceEventSink *aEventSink)=0
 Registers an event sink that will want to receive the raw events and GenICam invalidator events. More...
 
virtual PvResult UnregisterEventSink (IPvDeviceEventSink *aEventSink)=0
 Unregisters an event sink registered with RegisterEventSink. More...
 

Detailed Description

Interface used by PvDeviceSerialPort to interact with a device controller.

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

In order to use PvDeviceSerialPort with a third-party SDK, inherit your own class from IPvDeviceAdapter and implement all pure methods.

You need to forward GenICam invalidation events for all IPvDeviceEventSink interfaces registered using RegisterEventSink up until UnregisterEventSink is called.

Use IPvDeviceEventSink::NotifyInvalidatedGenParameter for parameters that RegisterGenInvalidator was called for. You also need to forward all messaging channel events to the PvDeviceSerialPort using IPvDeviceEventSink::NotifyEvent.

Member Function Documentation

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

Returns the value of a Boolean identified by its name.

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

Implemented in PvDeviceAdapter.

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

Returns a list of all available enum entries for an enumeration.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::GetGenEnumValue ( const PvString aParameterName,
PvString aEnumEntry 
)
pure virtual

Returns the string value of an enumeration identified by its name.

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

Implemented in PvDeviceAdapter.

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

Returns the value of an integer identified by its name.

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

Implemented in PvDeviceAdapter.

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

Gets the data contained in a register identified by its name.

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.

Implemented in PvDeviceAdapter.

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

Gets the length (in bytes) of a register identified by its name.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::GetGenStringValue ( const PvString aParameterName,
PvString aValue 
)
pure 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.

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsConnected ( )
pure virtual

Returns true if the device is connected.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenBooleanInNodeMap ( const PvString aParameterName)
pure virtual

Returns true if the device node map contains a Boolean of the specified name.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenEnumEntryAvailable ( const PvString aParameterName,
const PvString aEnumEntry 
)
pure virtual

Returns true if an enumeration is present in the node map and has a specific enum entry.

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.

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenEnumInNodeMap ( const PvString aParameterName)
pure virtual

Returns true if the device node map contains an enumeration of the specified name.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenIntegerInNodeMap ( const PvString aParameterName)
pure virtual

Returns true if the device node map contains an integer of the specified name.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenReadable ( const PvString aParameterName)
pure virtual

Returns true if a parameter is present and readable in the node map.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenRegisterInNodeMap ( const PvString aParameterName)
pure virtual

Returns true if the device node map contains a raw register of the specified name.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGenWritable ( const PvString aParameterName)
pure virtual

Returns true if a parameter is present and writable in the node map.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsGigEVision ( )
pure virtual

Returns true if the device uses the GigE Vision protocol.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsPleoraPowered ( )
pure virtual

Returns true if the device runs on a Pleora design.

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

Implemented in PvDeviceAdapter.

bool IPvDeviceAdapter::IsUSB3Vision ( )
pure virtual

Returns true if the device uses the USB3 Vision protocol.

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

Implemented in PvDeviceAdapter.

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

Reads data from the memory of a device.

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

Implemented in PvDeviceAdapter.

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

Reads a 32 bit value from a GigE Vision register.

Should simply return NOT_IMPLEMENTED if the device is not GigE Vision. Serial communication methods supported by USB3 Vision devices do not use ReadRegister.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::RegisterEventSink ( IPvDeviceEventSink aEventSink)
pure virtual

Registers an event sink that will want to receive the raw events and GenICam invalidator events.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::RegisterGenInvalidator ( const PvString aParameterName)
pure virtual

Registers (and forward to the device serial object) invalidation events for a parameter identified by its name.

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

Implemented in PvDeviceAdapter.

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

Sets the value of a Boolean identified by its name.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::SetGenEnumValue ( const PvString aParameterName,
const PvString aEnumEntry 
)
pure virtual

Sets the value of an enumeration identified by its name.

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

Implemented in PvDeviceAdapter.

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

Sets the data contained in a register identified by its name.

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.

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::UnregisterEventSink ( IPvDeviceEventSink aEventSink)
pure virtual

Unregisters an event sink registered with RegisterEventSink.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::UnregisterGenInvalidator ( const PvString aParameterName)
pure virtual

Unregisters (and forward to the device serial object) invalidation events for a parameter identified by its name.

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

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::WaitForMessagingChannelIdle ( uint32_t  aTimeout)
pure virtual

Waits for the messaging channel queue to be empty.

Parameters
[in]aTimeoutHow long to wait for the messaging channel to become idle.
Returns
OK on success.

Implemented in PvDeviceAdapter.

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

Writes data to a the memory of a device.

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.

Implemented in PvDeviceAdapter.

PvResult IPvDeviceAdapter::WriteRegister ( int64_t  aAddress,
uint32_t  aValue 
)
pure virtual

Writes a 32 bit value to a GigE Vision register.

Should simply return NOT_IMPLEMENTED if the device is not GigE Vision. Serial communication methods supported by USB3 Vision devices do not use WriteRegister.

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

Implemented in PvDeviceAdapter.


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

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