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... | |
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.
|
pure virtual |
Returns the value of a Boolean identified by its name.
[in] | aParameterName | Name of the parameter. |
[out] | aValue | Value of the parameter. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns a list of all available enum entries for an enumeration.
[in] | aParameterName | Name of the parameter. |
[out] | aList | A list containing the string representation of all available enum entries. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns the string value of an enumeration identified by its name.
[in] | aParameterName | Name of the parameter. |
[out] | aEnumEntry | Value of the parameter. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns the value of an integer identified by its name.
[in] | aParameterName | Name of the parameter. |
[out] | aValue | Value of the parameter. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Gets the data contained in a register identified by its name.
[in] | aParameterName | Name of the parameter. |
[out] | aDataBuffer | Buffer where to copy the data. |
[in] | aByteCount | How many bytes to copy to aDataBuffer. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Gets the length (in bytes) of a register identified by its name.
[in] | aParameterName | Name of the parameter. |
[in] | aLength | Length (in bytes) of the register. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns the string value of string parameter identified by its name.
[in] | aParameterName | Name of the parameter. |
[out] | aValue | Value of the parameter. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device is connected.
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device node map contains a Boolean of the specified name.
[in] | aParameterName | Name of the parameter to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if an enumeration is present in the node map and has a specific enum entry.
[in] | aParameterName | Name of the parameter to test for. |
[in] | aEnumEntry | Name of the enum entry to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device node map contains an enumeration of the specified name.
[in] | aParameterName | Name of the parameter to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device node map contains an integer of the specified name.
[in] | aParameterName | Name of the parameter to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if a parameter is present and readable in the node map.
[in] | aParameterName | Name of the parameter to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device node map contains a raw register of the specified name.
[in] | aParameterName | Name of the parameter to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if a parameter is present and writable in the node map.
[in] | aParameterName | Name of the parameter to test for. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device uses the GigE Vision protocol.
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device runs on a Pleora design.
Implemented in PvDeviceAdapter.
|
pure virtual |
Returns true if the device uses the USB3 Vision protocol.
Implemented in PvDeviceAdapter.
|
pure virtual |
Reads data from the memory of a device.
[in] | aBuffer | Pointer of the buffer where the data will be written. |
[in] | aAddress | Address where to read the data. |
[aLength] | aLength Length of the data to read, in bytes. |
Implemented in PvDeviceAdapter.
|
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.
[in] | aAddress | Address of the register. |
[out] | aValue | Value read from the register. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Registers an event sink that will want to receive the raw events and GenICam invalidator events.
[in] | aEventSink | Pointer to an object implementing the IPvDeviceEventSink interface. |
Implemented in PvDeviceAdapter.
Registers (and forward to the device serial object) invalidation events for a parameter identified by its name.
[in] | aParameterName | Name of the parameter. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Sets the value of a Boolean identified by its name.
[in] | aParameterName | Name of the parameter. |
[in] | aValue | New value for the Boolean. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Sets the value of an enumeration identified by its name.
[in] | aParameterName | Name of the parameter. |
[in] | aEnumEntry | New value for the enumeration. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Sets the data contained in a register identified by its name.
[in] | aParameterName | Name of the parameter. |
[out] | aDataBuffer | Buffer to copy the data from. |
[in] | aByteCount | How many bytes to copy from aDataBuffer to the register. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Unregisters an event sink registered with RegisterEventSink.
[in] | aEventSink | Pointer to an object implementing the IPvDeviceEventSink interface. |
Implemented in PvDeviceAdapter.
Unregisters (and forward to the device serial object) invalidation events for a parameter identified by its name.
[in] | aParameterName | Name of the parameter. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Waits for the messaging channel queue to be empty.
[in] | aTimeout | How long to wait for the messaging channel to become idle. |
Implemented in PvDeviceAdapter.
|
pure virtual |
Writes data to a the memory of a device.
[in] | aBuffer | Pointer to the data to write. |
[in] | aAddress | Address where to write the data. |
[aLength] | aLength Length of the data to write, in bytes. |
Implemented in PvDeviceAdapter.
|
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.
[in] | aAddress | Address of the register. |
[in] | aValue | Value to write to the register. |
Implemented in PvDeviceAdapter.
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com