Interface to access basic information about a PvSoftDeviceGEV register. More...
Public Member Functions | |
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 to access basic information about a PvSoftDeviceGEV register.
This interface can be used to query basic information about a register.
This class cannot be instantiated and there is no use case where you would need to implement this interface.
|
pure virtual |
Returns the register address.
|
pure virtual |
Returns the contextual pointer provided at register creation.
|
pure virtual |
Returns the length of the register, in bytes.
|
pure virtual |
Returns the register name.
All PvSoftDeviceGEV registers are named. This method allows the user to retrieve this name.
The GigE Vision standard does not require that you name your registers. The name is used internally to provide contextual information about the register in logs or user interfaces.
|
pure virtual |
Indicates whether the register is readable.
|
pure virtual |
Indicates whether the register is writable.
Whether the register is writable (or not) is only enforced when the register is accessed from the GigE Vision controller.
Using the internal APIs it is possible to write to read-only registers. However, take care when doing so: If you do not fully control the custom register, it could cause issues (and is not recommended).
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com