Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvRegister Class Referenceabstract

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...
 
- Public Member Functions inherited from IPvRegisterInfo
virtual ~IPvRegisterInfo ()
 Virtual destructor.
 
virtual const PvStringGetName ()=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 void * GetContext ()=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...
 

Detailed Description

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.

Member Function Documentation

PvResult IPvRegister::AddEventSink ( IPvRegisterEventSink aEventSink)
pure virtual

Registers a IPvRegisterEventSink for register callbacks.

See also
IPvRegisterEventSink
Parameters
[in]aEventSinkPointer to the event sink.
Returns
Includes:
PvResult IPvRegister::Read ( uint8_t *  aData,
uint32_t  aByteCount,
uint32_t  aOffset = 0 
)
pure virtual

Reads a register to an array of bytes.

Parameters
[in]aDataPointer to the data where the data is read to.
[in]aByteCountLength of the read operation.
[in]aOffsetOffset (in bytes) of the read operation in the register.
Returns
Includes:
PvResult IPvRegister::Read ( uint32_t &  aValue,
uint32_t  aOffset = 0 
)
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.

Parameters
[out]aValueOutput of the read operation.
[in]aOffsetOffset of the read operation in the register.
Returns
Includes:
PvResult IPvRegister::Read ( PvString aValue)
pure virtual

Reads the register content to a string.

Convenience method. Works the same as the byte-array Read but reads to a string directly.

Parameters
[out]aValueOutput of the read operation.
Returns
Includes:
PvResult IPvRegister::ReadDouble ( double &  aValue)
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.

Parameters
[out]aValueOutput of the read operation.
Returns
Includes:
PvResult IPvRegister::ReadFloat ( float &  aValue)
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.

Parameters
[out]aValueOutput of the read operation.
Returns
Includes:
PvResult IPvRegister::RemoveEventSink ( IPvRegisterEventSink aEventSink)
pure virtual

Removes an event sink registered with AddEventSink.

Parameters
[in]aEventSinkPointer to the event sink that is being removed.
Returns
Includes:
PvResult IPvRegister::Write ( const uint8_t *  aData,
uint32_t  aByteCount,
uint32_t  aOffset = 0 
)
pure virtual

Writes an array of bytes to a register.

Parameters
[in]aDataPointer to the data to write to the register.
[in]aByteCountLength of write operation.
[in]aOffsetOffset (in bytes) of the write operation in the register.
Returns
Includes:
PvResult IPvRegister::Write ( uint32_t  aValue,
uint32_t  aOffset = 0 
)
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.

Parameters
[in]aValueValue to write to the register.
[in]aOffsetOffset of the write operation in the register.
Returns
Includes:
PvResult IPvRegister::Write ( const PvString aValue)
pure virtual

Writes the register content from a string.

Convenience method. Works the same as the byte-array Write but writes from a string directly.

Parameters
[in]aValueValue to write to the register.
Returns
Includes:
PvResult IPvRegister::WriteDouble ( double  aValue)
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.

Parameters
[in]aValueValue to write to the register.
Returns
Includes:
PvResult IPvRegister::WriteFloat ( float  aValue)
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.

Parameters
[in]aValueValue to write to the register.
Returns
Includes:

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

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