Pleora Technologies Inc. eBUS SDK v6.4.0.6670 API



Public Member Functions | List of all members
IPvRegisterInfo Class Referenceabstract

Interface to access basic information about a PvSoftDeviceGEV register. More...

#include <PvSoftDeviceGEVInterfaces.h>

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 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...
 
virtual bool IsArrayOfBytes () const =0
 Indicates whether the register is an array of bytes or plain data type. More...
 

Detailed Description

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.

Member Function Documentation

◆ GetAddress()

virtual uint32_t IPvRegisterInfo::GetAddress ( ) const
pure virtual

Returns the register address.

Returns
Register address.

◆ GetContext() [1/2]

virtual const void* IPvRegisterInfo::GetContext ( ) const
pure virtual

Returns the contextual pointer provided at register creation.

Returns
Const contextual pointer.

◆ GetContext() [2/2]

virtual void* IPvRegisterInfo::GetContext ( )
pure virtual

Returns the contextual pointer provided at register creation.

Returns
Contextual pointer.

◆ GetLength()

virtual size_t IPvRegisterInfo::GetLength ( ) const
pure virtual

Returns the length of the register, in bytes.

Returns
Register length.

◆ GetName()

virtual const PvString& IPvRegisterInfo::GetName ( )
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.

Returns
Register name.

◆ IsArrayOfBytes()

virtual bool IPvRegisterInfo::IsArrayOfBytes ( ) const
pure virtual

Indicates whether the register is an array of bytes or plain data type.

Returns
True if the register is array of bytes.

◆ IsReadable()

virtual bool IPvRegisterInfo::IsReadable ( ) const
pure virtual

Indicates whether the register is readable.

Returns
True if the register is readable.

◆ IsWritable()

virtual bool IPvRegisterInfo::IsWritable ( ) const
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).

Returns
True if the register is writable.
The documentation for this class was generated from the following file:

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