Class Spinnaker::GenApi::RegisterNode

ClassList > GenApi > RegisterNode

Interface for string properties.

• #include <RegisterNode.h>

Inherits the following classes: IRegister, Spinnaker::GenApi::ValueNode

Inherited by the following classes: Spinnaker::GenApi::FloatRegNode, Spinnaker::GenApi::IntRegNode, Spinnaker::GenApi::StringRegNode

Public Functions

Type	Name
virtual void	Get (uint8_t * pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)
virtual int64_t	GetAddress ()
virtual int64_t	GetLength ()
	RegisterNode ()
	RegisterNode (std::shared_ptr< Node::NodeImpl > pRegister)
virtual void	Set (const uint8_t * pBuffer, int64_t Length, bool Verify=true)
virtual void	SetReference (INode * pBase)
virtual	~RegisterNode ()

Public Functions inherited from Spinnaker::GenApi::ValueNode

See Spinnaker::GenApi::ValueNode

Type	Name
virtual void	FromString (const GenICam::gcstring & ValueStr, bool Verify=true)
virtual INode *	GetNode ()
virtual bool	IsValueCacheValid () const
virtual bool	IsValueUpdated ()
virtual void	SetReference (INode * pBase)
virtual GenICam::gcstring	ToString (bool Verify=false, bool IgnoreCache=false)
	ValueNode ()
	ValueNode (std::shared_ptr< Node::NodeImpl > pValue)
	~ValueNode ()

Public Functions inherited from Spinnaker::GenApi::Node

See Spinnaker::GenApi::Node

Type	Name
virtual bool	DeregisterCallback (CallbackHandleType hCallback)
virtual EAccessMode	GetAccessMode () const Base interface overrides.
virtual INode *	GetAlias () const
virtual ECachingMode	GetCachingMode () const
virtual INode *	GetCastAlias () const
virtual void	GetChildren (GenApi::NodeList_t & Children, ELinkType LinkType=ctReadingChildren) const Get all nodes this node directly depends on.
virtual GenICam::gcstring	GetDescription () const
virtual GenICam::gcstring	GetDeviceName () const
virtual GenICam::gcstring	GetDisplayName () const
virtual GenICam::gcstring	GetDocuURL () const
virtual GenICam::gcstring	GetEventID () const
virtual void	GetLockNodes (GenApi::NodeList_t & LockNodes) const Gets all nodes which can directly lock this node.
virtual GenICam::gcstring	GetName (bool FullQualified=false) const
virtual GenApi::ENameSpace	GetNameSpace () const
std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
virtual INodeMap *	GetNodeMap () const
virtual void	GetParents (GenApi::NodeList_t & Parents) const Gets all nodes this node is directly depending on.
virtual int64_t	GetPollingTime () const
virtual EInterfaceType	GetPrincipalInterfaceType () const
virtual bool	GetProperty (const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr)
virtual void	GetPropertyNames (GenICam::gcstring_vector & PropertyNames) const
virtual void	GetSelectedFeatures (FeatureList_t &) const
virtual void	GetSelectingFeatures (FeatureList_t &) const
virtual GenICam::gcstring	GetToolTip () const
virtual EVisibility	GetVisibility () const
virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode)
virtual void	ImposeVisibility (EVisibility ImposedVisibility)
virtual void	InvalidateNode ()
virtual EYesNo	IsAccessModeCacheable () const
virtual bool	IsCachable () const
virtual bool	IsDeprecated () const
virtual bool	IsFeature () const
virtual bool	IsSelector () const Selector interface overrides.
virtual bool	IsStreamable () const
	Node ()
	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
virtual CallbackHandleType	RegisterCallback (CNodeCallback * pCallback)
void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
void	SetNodeMap (INodeMap * pNodeMap)
virtual void	SetReference (INode * pBase) Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void	SetReference (ISelector * pBase)
virtual bool	operator!= (int nullPtr) const
virtual bool	operator== (int nullPtr) const
	~Node ()

Protected Attributes inherited from Spinnaker::GenApi::Node

See Spinnaker::GenApi::Node

Type	Name
std::list< CallbackHandleType_t * >	m_Callbacks
std::shared_ptr< Node::NodeImpl >	m_pNodeData
INodeMap *	m_pNodeMap

Public Functions Documentation

function Get

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

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 GenApi::RegisterNode::GetAddress () 

Retrieves the Address of the register

---

function GetLength

virtual int64_t GenApi::RegisterNode::GetLength () 

Retrieves the Length of the register [Bytes]

---

function RegisterNode [1/2]

GenApi::RegisterNode::RegisterNode () 

---

function RegisterNode [2/2]

GenApi::RegisterNode::RegisterNode (
    std::shared_ptr< Node::NodeImpl > pRegister
) 

---

function Set

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

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)

---

function SetReference

virtual void GenApi::RegisterNode::SetReference (
    INode * pBase
) 

overload SetReference for Register

Implements Spinnaker::GenApi::ValueNode::SetReference

---

function ~RegisterNode

virtual GenApi::RegisterNode::~RegisterNode () 

---

---

The documentation for this class was generated from the following file C:/workspace/include/SpinGenApi/RegisterNode.h