INode.h File Reference

Namespaces
namespace	Spinnaker
namespace	Spinnaker::GenApi

Typedefs
typedef node_vector	NodeList_t
	a list of node references
typedef intptr_t	CallbackHandleType
	the callback handle for nodes

Functions
virtual GenApi::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.
virtual bool	IsCachable () const =0
	Is the node value cacheable.
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 non-cacheable nodes)
virtual GenICam::gcstring	GetToolTip ()=0
	Get tool tip.
virtual GenICam::gcstring	GetDescription () const =0
	Get a long description of the node.
virtual GenICam::gcstring	GetDisplayName () const =0
	Get a name string for display.
virtual GenICam::gcstring	GetDeviceName () const =0
	Get a name of the device.
virtual void	GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const =0
	Get all nodes this node directly depends on.
virtual void	GetParents (GenApi::NodeList_t &Parents) const =0
	Gets all nodes this node is directly depending on.
virtual void	GetLockNodes (GenApi::NodeList_t &LockNodes) const =0
	Gets all nodes which can directly lock this node.
virtual CallbackHandleType	RegisterCallback (CNodeCallback *pCallback)=0
	Register change callback Takes ownership of the CNodeCallback object.
virtual bool	DeregisterCallback (CallbackHandleType hCallback)=0
	De register change callback Destroys CNodeCallback object.
virtual INodeMap *	GetNodeMap () const =0
	Retrieves the central node map.
virtual GenICam::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::gcstring_vector &PropertyNames) const =0
	Returns a list of the names all properties set during initialization.
virtual bool	GetProperty (const GenICam::gcstring &PropertyName, GenICam::gcstring &ValueStr, GenICam::gcstring &AttributeStr)=0
	Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters.
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::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".
virtual bool	operator== (int nullPtr) const =0
virtual bool	operator!= (int nullPtr) const =0
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 CAVE : this relies on the EVisibility enum's coding.
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
interface SPINNAKER_API_ABSTRACT	INode
	Interface common to all nodes.
interface SPINNAKER_API_ABSTRACT virtual public	IReference
	Interface to construct a reference.