Skip to content

Group IRegister_h

Modules > IRegister_h

Public Attributes

Type Name
interface SPINNAKER_API_ABSTRACT IRegister
Interface for registers.

Public Functions

Type Name
virtual void Get (uint8_t * pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false) = 0
virtual int64_t GetAddress () = 0
virtual int64_t GetLength () = 0

Public Attributes Documentation

variable IRegister

Interface for registers.

interface SPINNAKER_API_ABSTRACT Spinnaker::GenApi::IRegister;


Public Functions Documentation

function Get

virtual void Get (
    uint8_t * pBuffer,
    int64_t Length,
    bool Verify=false,
    bool IgnoreCache=false
) = 0

Fills a buffer with the register's contents

Parameters:

  • pBuffer The buffer receiving the data to read
  • Length The number of bytes to retrieve
  • Verify Enables Range verification (default = false). The AccessMode is always checked
  • IgnoreCache If true the value is read ignoring any caches (default = false)

Returns:

The value read


function GetAddress

virtual int64_t GetAddress () = 0

Retrieves the Address of the register


function GetLength

virtual int64_t GetLength () = 0

Retrieves the Length of the register [Bytes]