Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
RegisterNode Class Reference

Interface for string properties. More...

Inheritance diagram for RegisterNode:
ValueNode Node FloatRegNode IntRegNode StringRegNode

Public Member Functions

 RegisterNode ()
 
 RegisterNode (std::shared_ptr< Node::NodeImpl > pRegister)
 
virtual ~RegisterNode ()
 
virtual void Set (const uint8_t *pBuffer, int64_t Length, bool Verify=true)
 Set the register's contents. More...
 
virtual void Get (uint8_t *pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)
 Fills a buffer with the register's contents. More...
 
virtual int64_t GetLength ()
 Retrieves the Length of the register [Bytes]. More...
 
virtual int64_t GetAddress ()
 Retrieves the Address of the register. More...
 
virtual void SetReference (INode *pBase)
 overload SetReference for Register More...
 
- Public Member Functions inherited from ValueNode
 ValueNode ()
 Constructor. More...
 
 ValueNode (std::shared_ptr< Node::NodeImpl > pValue)
 constructor with GenICam IValue More...
 
 ~ValueNode ()
 Destructor. More...
 
virtual INodeGetNode ()
 
virtual GenICam::gcstring ToString (bool Verify=false, bool IgnoreCache=false)
 Get content of the node as string. More...
 
virtual void FromString (const GenICam::gcstring &ValueStr, bool Verify=true)
 Set content of the node as string. More...
 
virtual bool IsValueCacheValid () const
 Checks if the value comes from cache or is requested from another node. More...
 
- Public Member Functions inherited from Node
 Node ()
 Constructor. More...
 
 Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Constructor. More...
 
 ~Node ()
 Destructor. More...
 
virtual GenICam::gcstring GetName (bool FullQualified=false) const
 Get node name. More...
 
virtual GenApi::ENameSpace GetNameSpace () const
 Get name space. More...
 
virtual EVisibility GetVisibility () const
 Get the recommended visibility of the node. More...
 
virtual void InvalidateNode ()
 Indicates that the node's value may have changed. More...
 
virtual bool IsCachable () const
 Is the node value cacheable. More...
 
virtual EYesNo IsAccessModeCacheable () const
 True if the AccessMode can be cached. More...
 
virtual ECachingMode GetCachingMode () const
 Get Caching Mode. More...
 
virtual int64_t GetPollingTime () const
 recommended polling time (for not cacheable nodes) More...
 
virtual GenICam::gcstring GetToolTip () const
 Get a short description of the node. More...
 
virtual GenICam::gcstring GetDescription () const
 Get a long description of the node. More...
 
virtual GenICam::gcstring GetDisplayName () const
 Get a name string for display. More...
 
virtual GenICam::gcstring GetDeviceName () const
 Get a name of the device. More...
 
virtual void GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const
 Get all nodes this node directly depends on. More...
 
virtual void GetParents (GenApi::NodeList_t &Parents) const
 Gets all nodes this node is directly depending on. More...
 
virtual CallbackHandleType RegisterCallback (CNodeCallback *pCallback)
 Register change callback Takes ownership of the CNodeCallback object. More...
 
virtual bool DeregisterCallback (CallbackHandleType hCallback)
 De register change callback Destroys CNodeCallback object. More...
 
virtual INodeMapGetNodeMap () const
 Retrieves the central node map. More...
 
virtual GenICam::gcstring GetEventID () const
 Get the EventId of the node. More...
 
virtual bool IsStreamable () const
 True if the node is streamable. More...
 
virtual void GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const
 Returns a list of the names all properties set during initialization. More...
 
virtual bool GetProperty (const GenICam::gcstring &PropertyName, GenICam::gcstring &ValueStr, GenICam::gcstring &AttributeStr)
 Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters. More...
 
virtual void ImposeAccessMode (EAccessMode ImposedAccessMode)
 Imposes an access mode to the natural access mode of the node. More...
 
virtual void ImposeVisibility (EVisibility ImposedVisibility)
 Imposes a visibility to the natural visibility of the node. More...
 
virtual INodeGetAlias () const
 Retrieves the a node which describes the same feature in a different way. More...
 
virtual INodeGetCastAlias () const
 Retrieves the a node which describes the same feature so that it can be casted. More...
 
virtual GenICam::gcstring GetDocuURL () const
 Gets a URL pointing to the documentation of that feature. More...
 
virtual bool IsDeprecated () const
 True if the node should not be used any more. More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a node. More...
 
virtual bool IsFeature () const
 True if the node can be reached via category nodes from a category node named "Root". More...
 
void SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Set Node handle. More...
 
std::shared_ptr< Node::NodeImpl > GetNodeHandle () const
 Get Node handle. More...
 
virtual EAccessMode GetAccessMode () const
 Base interface overrides. More...
 
virtual bool IsSelector () const
 Selector interface overrides. More...
 
virtual void GetSelectedFeatures (FeatureList_t &) const
 retrieve the group of selected features More...
 
virtual void GetSelectingFeatures (FeatureList_t &) const
 retrieve the group of features selecting this node More...
 
virtual void SetReference (ISelector *pBase)
 
void SetNodeMap (INodeMap *pNodeMap)
 
virtual bool operator== (int nullPtr) const
 
virtual bool operator!= (int nullPtr) const
 

Additional Inherited Members

- Protected Attributes inherited from Node
std::shared_ptr< Node::NodeImpl > m_pNodeData
 
std::list< CallbackHandleType_t * > m_Callbacks
 List of callbacks. More...
 
INodeMapm_pNodeMap
 

Detailed Description

Interface for string properties.

Constructor & Destructor Documentation

RegisterNode ( std::shared_ptr< Node::NodeImpl >  pRegister)
virtual ~RegisterNode ( )
virtual

Member Function Documentation

virtual void Get ( uint8_t *  pBuffer,
int64_t  Length,
bool  Verify = false,
bool  IgnoreCache = false 
)
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)
Returns
The value read
virtual int64_t GetAddress ( )
virtual

Retrieves the Address of the register.

virtual int64_t GetLength ( )
virtual

Retrieves the Length of the register [Bytes].

virtual void Set ( const uint8_t *  pBuffer,
int64_t  Length,
bool  Verify = true 
)
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 void SetReference ( INode pBase)
virtual

overload SetReference for Register

Reimplemented from ValueNode.

Reimplemented in StringRegNode, FloatRegNode, and IntRegNode.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference