Interface that is used to access the registers of the software-based GigE Vision Device. More...
Public Member Functions | |
virtual | ~IPvRegister () |
Virtual destructor. | |
virtual PvResult | Read (uint8_t *aData, uint32_t aByteCount, uint32_t aOffset=0)=0 |
Reads a register to an array of bytes. More... | |
virtual PvResult | Write (const uint8_t *aData, uint32_t aByteCount, uint32_t aOffset=0)=0 |
Writes an array of bytes to a register. More... | |
virtual PvResult | Read (uint32_t &aValue, uint32_t aOffset=0)=0 |
Reads the register content to a 4-byte unsigned integer. More... | |
virtual PvResult | Write (uint32_t aValue, uint32_t aOffset=0)=0 |
Writes the register content from a 4-byte unsigned integer. More... | |
virtual PvResult | Read (PvString &aValue)=0 |
Reads the register content to a string. More... | |
virtual PvResult | Write (const PvString &aValue)=0 |
Writes the register content from a string. More... | |
virtual PvResult | ReadFloat (float &aValue)=0 |
Reads the register content to a 4-byte float. More... | |
virtual PvResult | WriteFloat (float aValue)=0 |
Writes the register content from a float. More... | |
virtual PvResult | ReadDouble (double &aValue)=0 |
Reads the register content to a double precision floating point. More... | |
virtual PvResult | WriteDouble (double aValue)=0 |
Writes the register content from a double precision floating point. More... | |
virtual PvResult | AddEventSink (IPvRegisterEventSink *aEventSink)=0 |
Registers a IPvRegisterEventSink for register callbacks. More... | |
virtual PvResult | RemoveEventSink (IPvRegisterEventSink *aEventSink)=0 |
Removes an event sink registered with AddEventSink. More... | |
![]() | |
virtual | ~IPvRegisterInfo () |
Virtual destructor. | |
virtual const PvString & | GetName ()=0 |
Returns the register name. More... | |
virtual uint32_t | GetAddress () const =0 |
Returns the register address. More... | |
virtual size_t | GetLength () const =0 |
Returns the length of the register, in bytes. More... | |
virtual const void * | GetContext () const =0 |
Returns the contextual pointer provided at register creation. More... | |
virtual bool | IsWritable () const =0 |
Indicates whether the register is writable. More... | |
virtual bool | IsReadable () const =0 |
Indicates whether the register is readable. More... | |
Interface that is used to access the registers of the software-based GigE Vision Device.
This interface is retrieved through the IPvRegisterMap interface and can be used to read from or write to registers. It is also possible to register event sinks to registers using this interface.
This interface cannot be instantiated and there is no use case where you would need to implement this interface.
|
pure virtual |
Registers a IPvRegisterEventSink for register callbacks.
[in] | aEventSink | Pointer to the event sink. |
Reads the register content to a string.
Convenience method. Works the same as the byte-array Read but reads to a string directly.
[out] | aValue | Output of the read operation. |
|
pure virtual |
Reads the register content to a 4-byte unsigned integer.
Convenience method. Works the same as the byte-array Read but reads to a 4-byte unsigned integer directly.
[out] | aValue | Output of the read operation. |
[in] | aOffset | Offset of the read operation in the register. |
|
pure virtual |
Reads a register to an array of bytes.
[in] | aData | Pointer to the data where the data is read to. |
[in] | aByteCount | Length of the read operation. |
[in] | aOffset | Offset (in bytes) of the read operation in the register. |
|
pure virtual |
Reads the register content to a double precision floating point.
Convenience method. Works the same as the byte-array Read but reads to a double precision float directly.
[out] | aValue | Output of the read operation. |
|
pure virtual |
Reads the register content to a 4-byte float.
Convenience method. Works the same as the byte-array Read but reads to a float directly.
[out] | aValue | Output of the read operation. |
|
pure virtual |
Removes an event sink registered with AddEventSink.
[in] | aEventSink | Pointer to the event sink that is being removed. |
Writes the register content from a string.
Convenience method. Works the same as the byte-array Write but writes from a string directly.
[in] | aValue | Value to write to the register. |
|
pure virtual |
Writes an array of bytes to a register.
[in] | aData | Pointer to the data to write to the register. |
[in] | aByteCount | Length of write operation. |
[in] | aOffset | Offset (in bytes) of the write operation in the register. |
|
pure virtual |
Writes the register content from a 4-byte unsigned integer.
Convenience method. Works the same as the byte-array Write but writes from a 4-byte unsigned integer directly.
[in] | aValue | Value to write to the register. |
[in] | aOffset | Offset of the write operation in the register. |
|
pure virtual |
Writes the register content from a double precision floating point.
Convenience method. Works the same as the byte-array Write but writes from a double precision float directly.
[in] | aValue | Value to write to the register. |
|
pure virtual |
Writes the register content from a float.
Convenience method. Works the same as the byte-array Write but writes from a float directly.
[in] | aValue | Value to write to the register. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com