Skip to content

GenApi::CRegisterRefT#

More…

Inherits from GenApi::CValueRefT< T >

Public Functions#

Name
virtual void Set(const uint8_t * pBuffer, int64_t Length, bool Verify =true)
Set the register's contents.
virtual void Get(uint8_t * pBuffer, int64_t Length, bool Verify =false, bool IgnoreCache =false)
Fills a buffer with the register's contents.
virtual int64_t GetLength()
Retrieves the Length of the register [Bytes].
virtual int64_t GetAddress()
Retrieves the Address of the register.
virtual INode * GetNode()
Get the INode interface of the node.
virtual GenICam::gcstring ToString(bool Verify =false, bool IgnoreCache =false)
Get content of the node as string.
virtual void FromString(const GenICam::gcstring & ValueStr, bool Verify =true)
Set content of the node as string.
virtual bool IsValueCacheValid() const
Checks if the value comes from cache or is requested from another node.
virtual EAccessMode GetAccessMode() const
Get the access mode of the node.

Detailed Description#

template <class T >
class GenApi::CRegisterRefT;

Public Functions Documentation#

function Set#

inline virtual void Set(
    const uint8_t * pBuffer,
    int64_t Length,
    bool Verify =true
)

Set the register's contents.

function Get#

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

Fills a buffer with the register's contents.

function GetLength#

inline virtual int64_t GetLength()

Retrieves the Length of the register [Bytes].

function GetAddress#

inline virtual int64_t GetAddress()

Retrieves the Address of the register.

function GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

function ToString#

inline virtual GenICam::gcstring ToString(
    bool Verify =false,
    bool IgnoreCache =false
)

Get content of the node as string.

function FromString#

inline virtual void FromString(
    const GenICam::gcstring & ValueStr,
    bool Verify =true
)

Set content of the node as string.

function IsValueCacheValid#

inline virtual bool IsValueCacheValid() const

Checks if the value comes from cache or is requested from another node.

function GetAccessMode#

inline virtual EAccessMode GetAccessMode() const

Get the access mode of the node.