IRegister Interfaces

Functions
virtual void	Get (uint8_t *pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)=0
	Fills a buffer with the register's contents.
virtual int64_t	GetLength ()=0
	Retrieves the Length of the register [Bytes].
virtual int64_t	GetAddress ()=0
	Retrieves the Address of the register.

Variables
interface SPINNAKER_API_ABSTRACT	IRegister
	Interface for registers.

Detailed Description

Function Documentation

Get()

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

pure virtual

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

GetAddress()

virtual int64_t GetAddress ( )

pure virtual

Retrieves the Address of the register.

GetLength()

virtual int64_t GetLength ( )

pure virtual

Retrieves the Length of the register [Bytes].

Variable Documentation

IRegister

interface SPINNAKER_API_ABSTRACT IRegister

Interface for registers.