Definition of interface INode and types NodeList_t and CallbackHandleType: More...

Typedefs
typedef node_vector	NodeList_t
	a list of node references

typedef intptr_t	CallbackHandleType
	the callback handle for nodes

Functions
virtual GENAPI_NAMESPACE::ENameSpace	GetNameSpace () const =0
	Get name space.

virtual EVisibility	GetVisibility () const =0
	Get the recommended visibility of the node.

virtual void	InvalidateNode ()=0
	Indicates that the node's value may have changed. More...

virtual bool	IsCachable () const =0
	Is the node value cachable.

virtual EYesNo	IsAccessModeCacheable () const =0
	True if the AccessMode can be cached.

virtual ECachingMode	GetCachingMode () const =0
	Get Caching Mode.

virtual int64_t	GetPollingTime () const =0
	recommended polling time (for not cachable nodes)

virtual GENICAM_NAMESPACE::gcstring	GetToolTip ()=0
	Get tool tip. More...

virtual GENICAM_NAMESPACE::gcstring	GetDescription () const =0
	Get a long description of the node.

virtual GENICAM_NAMESPACE::gcstring	GetDisplayName () const =0
	Get a name string for display.

virtual GENICAM_NAMESPACE::gcstring	GetDeviceName () const =0
	Get a name of the device. More...

virtual void	GetChildren (GENAPI_NAMESPACE::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const =0
	Get all nodes this node directly depends on. More...

virtual void	GetParents (GENAPI_NAMESPACE::NodeList_t &Parents) const =0
	Gets all nodes this node is directly depending on. More...

virtual CallbackHandleType	RegisterCallback (CNodeCallback *pCallback)=0
	Register change callback. More...

virtual bool	DeregisterCallback (CallbackHandleType hCallback)=0
	De register change callback. More...

virtual INodeMap *	GetNodeMap () const =0
	Retrieves the central node map.

virtual GENICAM_NAMESPACE::gcstring	GetEventID () const =0
	Get the EventId of the node.

virtual bool	IsStreamable () const =0
	True if the node is streamable.

virtual void	GetPropertyNames (GENICAM_NAMESPACE::gcstring_vector &PropertyNames) const =0
	Returns a list of the names all properties set during initialization.

virtual bool	GetProperty (const GENICAM_NAMESPACE::gcstring &PropertyName, GENICAM_NAMESPACE::gcstring &ValueStr, GENICAM_NAMESPACE::gcstring &AttributeStr)=0
	Retrieves a property plus an additional attribute by name. More...

virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode)=0
	Imposes an access mode to the natural access mode of the node.

virtual void	ImposeVisibility (EVisibility ImposedVisibility)=0
	Imposes a visibility to the natural visibility of the node.

virtual INode *	GetAlias () const =0
	Retrieves the a node which describes the same feature in a different way.

virtual INode *	GetCastAlias () const =0
	Retrieves the a node which describes the same feature so that it can be casted.

virtual GENICAM_NAMESPACE::gcstring	GetDocuURL () const =0
	Gets a URL pointing to the documentation of that feature.

virtual bool	IsDeprecated () const =0
	True if the node should not be used any more.

virtual EInterfaceType	GetPrincipalInterfaceType () const =0
	Get the type of the main interface of a node.

virtual bool	IsFeature () const =0
	True if the node can be reached via category nodes from a category node named "Root".

bool	IsReadable (EAccessMode AccessMode)
	Tests if readable.

bool	IsReadable (const IBase *p)
	Checks if a node is readable.

bool	IsReadable (const IBase &r)
	Checks if a node is readable.

bool	IsWritable (EAccessMode AccessMode)
	Tests if writable.

bool	IsWritable (const IBase *p)
	Checks if a node is writable.

bool	IsWritable (const IBase &r)
	Checks if a node is writable.

bool	IsImplemented (EAccessMode AccessMode)
	Tests if implemented.

bool	IsImplemented (const IBase *p)
	Checks if a node is implemented.

bool	IsImplemented (const IBase &r)
	Checks if a node is implemented.

bool	IsAvailable (EAccessMode AccessMode)
	Tests if available.

bool	IsAvailable (const IBase *p)
	Checks if a node is available.

bool	IsAvailable (const IBase &r)
	Checks if a node is available.

EAccessMode	Combine (EAccessMode Peter, EAccessMode Paul)
	Computes which access mode the two guards allow together.

bool	IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
	Tests Visibility. More...

EVisibility	Combine (EVisibility Peter, EVisibility Paul)
	Computes which visibility the two guards allow together.

bool	IsCacheable (ECachingMode CachingMode)
	Tests Cacheability.

ECachingMode	Combine (ECachingMode Peter, ECachingMode Paul)
	Computes which CachingMode results from a combination.

Variables
GENICAM_INTERFACE	INodeMap
	Interface to access the node map.

Function Documentation

◆ InvalidateNode()

virtual void GENAPI_NAMESPACE::InvalidateNode ( )

pure virtual

Fires the callback on this and all dependent nodes

◆ GetToolTip()

GENICAM_NAMESPACE::gcstring GetToolTip ( )

pure virtual

Get a short description of the node.

◆ GetDeviceName()

GENICAM_NAMESPACE::gcstring GetDeviceName ( )

pure virtual

Get device name.

The device name identifies a device instance, e.g. for debugging purposes. The default ist "Device".

◆ GetChildren()

virtual void GENAPI_NAMESPACE::GetChildren	(	GENAPI_NAMESPACE::NodeList_t &	Children,
		ELinkType	LinkType = `ctReadingChildren`
	)		const

pure virtual

Parameters

[out]	Children	List of children nodes
	LinkType	The link type

◆ GetParents()

virtual void GENAPI_NAMESPACE::GetParents ( GENAPI_NAMESPACE::NodeList_t & Parents ) const

pure virtual

Parameters

[out] Parents List of parent nodes

◆ RegisterCallback()

virtual CallbackHandleType GENAPI_NAMESPACE::RegisterCallback ( CNodeCallback * pCallback )

pure virtual

Takes ownership of the CNodeCallback object

◆ DeregisterCallback()

virtual bool GENAPI_NAMESPACE::DeregisterCallback ( CallbackHandleType hCallback )

pure virtual

Destroys CNodeCallback object

Returns: true if the callback handle was valid

◆ GetProperty()

virtual bool GENAPI_NAMESPACE::GetProperty	(	const GENICAM_NAMESPACE::gcstring &	PropertyName,
		GENICAM_NAMESPACE::gcstring &	ValueStr,
		GENICAM_NAMESPACE::gcstring &	AttributeStr
	)

pure virtual

If a property has multiple values/attribute they come with Tabs as delimiters

Typedefs

Functions

Variables

Function Documentation

◆ InvalidateNode()

◆ GetToolTip()

◆ GetDeviceName()

◆ GetChildren()

◆ GetParents()

◆ RegisterCallback()

◆ DeregisterCallback()

◆ GetProperty()