All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
GenApi::IRegister Struct Referenceabstract

Interface for registers. More...

#include <GenApi/IRegister.h>

Inheritance diagram for GenApi::IRegister:
Inheritance graph
[legend]

Public Member Functions

virtual void Set (const uint8_t *pBuffer, int64_t Length, bool Verify=true)=0
 Set the register's contents. More...
 
virtual void Get (uint8_t *pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)=0
 Fills a buffer with the register's contents. More...
 
virtual int64_t GetLength ()=0
 Retrieves the Length of the register [Bytes].
 
virtual int64_t GetAddress ()=0
 Retrieves the Address of the register.
 
virtual INodeGetNode ()
 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. More...
 
virtual void FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0
 Set content of the node as string. More...
 
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.
 

Detailed Description

Interface for registers.

Member Function Documentation

virtual void GenApi::IValue::FromString ( const GenICam::gcstring ValueStr,
bool  Verify = true 
)
pure virtualinherited

Set content of the node as string.

Parameters
ValueStrThe value to set
VerifyEnables AccessMode and Range verification (default = true)
virtual void GenApi::IRegister::Get ( uint8_t *  pBuffer,
int64_t  Length,
bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Fills a buffer with the register's contents.

Parameters
pBufferThe buffer receiving the data to read
LengthThe number of bytes to retrieve
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
virtual void GenApi::IRegister::Set ( const uint8_t *  pBuffer,
int64_t  Length,
bool  Verify = true 
)
pure virtual

Set the register's contents.

Parameters
pBufferThe buffer containing the data to set
LengthThe number of bytes in pBuffer
VerifyEnables AccessMode and Range verification (default = true)
virtual GenICam::gcstring GenApi::IValue::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtualinherited

Get content of the node as string.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read

The documentation for this struct was generated from the following file:

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)