Skip to content
STAGING SERVER
DEVELOPMENT SERVER

GenApi::IRegister#

Module: GenICam / GenApi Node Interfaces and Access Mode Check Functions

Interface for registers.

#include <GenApi/IRegister.h>

Inherits from GenApi::IValue, GenApi::IBase

Inherited by Pylon::IRegisterEx

Public Functions#

Name
virtual void Set(const uint8_t * pBuffer, int64_t Length, bool Verify =true) =0
Set the register's contents.
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.
virtual INode * GetNode()
Get the INode interface of the node.
virtual GenICam::gcstring ToString(bool Verify =false, bool IgnoreCache =false) =0
Get content of the node as string.
virtual void FromString(const GenICam::gcstring & ValueStr, bool Verify =true) =0
Set content of the node as string.
virtual bool IsValueCacheValid() const =0
Checks if the value comes from cache or is requested from another node.
virtual EAccessMode GetAccessMode() const =0
Get the access mode of the node.

Additional inherited members#

Public Functions inherited from GenApi::IBase

Name
virtual ~IBase() =0
Virtual destructor enforcing virtual destructor on all derived classes.

Public Functions Documentation#

function Set#

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

Set the register's contents.

Parameters:

  • pBuffer The buffer containing the data to set
  • Length The number of bytes in pBuffer
  • Verify Enables AccessMode and Range verification (default = true)

Reimplemented by: Pylon::CArrayParameter::Set

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)

Reimplemented by: Pylon::CArrayParameter::Get

function GetLength#

virtual int64_t GetLength() =0

Retrieves the Length of the register [Bytes].

Reimplemented by: Pylon::CArrayParameter::GetLength

function GetAddress#

virtual int64_t GetAddress() =0

Retrieves the Address of the register.

Reimplemented by: Pylon::CArrayParameter::GetAddress

function GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

Reimplemented by: Pylon::CArrayParameter::GetNode

function ToString#

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

Get content of the node as string.

Parameters:

  • Verify Enables Range verification (default = false). The AccessMode is always checked
  • IgnoreCache If true the value is read ignoring any caches (default = false)

Return: The value read

Reimplemented by: Pylon::CArrayParameter::ToString

function FromString#

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

Set content of the node as string.

Parameters:

  • ValueStr The value to set
  • Verify Enables AccessMode and Range verification (default = true)

Reimplemented by: Pylon::CArrayParameter::FromString

function IsValueCacheValid#

virtual bool IsValueCacheValid() const =0

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

Reimplemented by: Pylon::CArrayParameter::IsValueCacheValid

function GetAccessMode#

virtual EAccessMode GetAccessMode() const =0

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode