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

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

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

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

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

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

virtual int64_t	GetPollingTime () const =0
	recommended polling time (for non-cacheable nodes) More...

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

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

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

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

virtual void	GetLockNodes (GenApi::NodeList_t &LockNodes) const =0
	Gets all nodes which can directly lock this node. More...

virtual CallbackHandleType	RegisterCallback (CNodeCallback *pCallback)=0
	Register change callback Takes ownership of the CNodeCallback object. More...

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

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

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

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

virtual void	GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const =0
	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)=0
	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)=0
	Imposes an access mode to the natural access mode of the node. More...

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

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

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

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

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

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

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

virtual bool	operator== (int nullPtr) const =0

virtual bool	operator!= (int nullPtr) const =0

bool	IsReadable (EAccessMode AccessMode)
	Tests if readable. More...

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

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

bool	IsWritable (EAccessMode AccessMode)
	Tests if writable. More...

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

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

bool	IsImplemented (EAccessMode AccessMode)
	Tests if implemented. More...

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

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

bool	IsAvailable (EAccessMode AccessMode)
	Tests if available. More...

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

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

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

bool	IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
	Tests Visibility CAVE : this relies on the EVisibility enum's coding. More...

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

bool	IsCacheable (ECachingMode CachingMode)
	Tests Cacheability. More...

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

Variables
interface SPINNAKER_API_ABSTRACT	INode
	Interface common to all nodes. More...

interface SPINNAKER_API_ABSTRACT virtual public	IReference
	Interface to construct a reference. More...

Detailed Description

Function Documentation

◆ Combine() [1/3]

EAccessMode Spinnaker::GenApi::Combine	(	EAccessMode	Peter,
		EAccessMode	Paul
	)

inline

Computes which access mode the two guards allow together.

◆ Combine() [2/3]

ECachingMode Spinnaker::GenApi::Combine	(	ECachingMode	Peter,
		ECachingMode	Paul
	)

inline

Computes which CachingMode results from a combination.

◆ Combine() [3/3]

EVisibility Spinnaker::GenApi::Combine	(	EVisibility	Peter,
		EVisibility	Paul
	)

inline

Computes which visibility the two guards allow together.

◆ DeregisterCallback()

virtual bool Spinnaker::GenApi::DeregisterCallback ( CallbackHandleType hCallback )

pure virtual

De register change callback Destroys CNodeCallback object.

Returns: true if the callback handle was valid

◆ GetAlias()

virtual INode* Spinnaker::GenApi::GetAlias ( ) const

pure virtual

Retrieves the a node which describes the same feature in a different way.

◆ GetCachingMode()

virtual ECachingMode Spinnaker::GenApi::GetCachingMode ( ) const

pure virtual

Get Caching Mode.

◆ GetCastAlias()

virtual INode* Spinnaker::GenApi::GetCastAlias ( ) const

pure virtual

Retrieves the a node which describes the same feature so that it can be casted.

◆ GetChildren()

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

pure virtual

Get all nodes this node directly depends on.

Parameters

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

◆ GetDescription()

virtual GenICam::gcstring Spinnaker::GenApi::GetDescription ( ) const

pure virtual

Get a long description of the node.

◆ GetDisplayName()

virtual GenICam::gcstring Spinnaker::GenApi::GetDisplayName ( ) const

pure virtual

Get a name string for display.

◆ GetDocuURL()

virtual GenICam::gcstring Spinnaker::GenApi::GetDocuURL ( ) const

pure virtual

Gets a URL pointing to the documentation of that feature.

◆ GetEventID()

virtual GenICam::gcstring Spinnaker::GenApi::GetEventID ( ) const

pure virtual

Get the EventId of the node.

◆ GetLockNodes()

virtual void Spinnaker::GenApi::GetLockNodes ( GenApi::NodeList_t & LockNodes ) const

pure virtual

Gets all nodes which can directly lock this node.

Parameters

[out] LockNodes List of lock nodes.

◆ GetNameSpace()

virtual GenApi::ENameSpace Spinnaker::GenApi::GetNameSpace ( ) const

pure virtual

Get name space.

◆ GetNodeMap()

virtual INodeMap* Spinnaker::GenApi::GetNodeMap ( ) const

pure virtual

Retrieves the central node map.

◆ GetParents()

virtual void Spinnaker::GenApi::GetParents ( GenApi::NodeList_t & Parents ) const

pure virtual

Gets all nodes this node is directly depending on.

Parameters

[out] Parents List of parent nodes

◆ GetPollingTime()

virtual int64_t Spinnaker::GenApi::GetPollingTime ( ) const

pure virtual

recommended polling time (for non-cacheable nodes)

◆ GetPrincipalInterfaceType()

virtual EInterfaceType Spinnaker::GenApi::GetPrincipalInterfaceType ( ) const

pure virtual

Get the type of the main interface of a node.

◆ GetProperty()

virtual bool Spinnaker::GenApi::GetProperty	(	const GenICam::gcstring &	PropertyName,
		GenICam::gcstring &	ValueStr,
		GenICam::gcstring &	AttributeStr
	)

pure virtual

Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters.

◆ GetPropertyNames()

virtual void Spinnaker::GenApi::GetPropertyNames ( GenICam::gcstring_vector & PropertyNames ) const

pure virtual

Returns a list of the names all properties set during initialization.

◆ GetVisibility()

virtual EVisibility Spinnaker::GenApi::GetVisibility ( ) const

pure virtual

Get the recommended visibility of the node.

◆ ImposeAccessMode()

virtual void Spinnaker::GenApi::ImposeAccessMode ( EAccessMode ImposedAccessMode )

pure virtual

Imposes an access mode to the natural access mode of the node.

◆ ImposeVisibility()

virtual void Spinnaker::GenApi::ImposeVisibility ( EVisibility ImposedVisibility )

pure virtual

Imposes a visibility to the natural visibility of the node.

◆ InvalidateNode()

virtual void Spinnaker::GenApi::InvalidateNode ( )

pure virtual

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

◆ IsAccessModeCacheable()

virtual EYesNo Spinnaker::GenApi::IsAccessModeCacheable ( ) const

pure virtual

True if the AccessMode can be cached.

◆ IsAvailable() [1/3]

bool Spinnaker::GenApi::IsAvailable ( const IBase & r )

inline

Checks if a node is available.

◆ IsAvailable() [2/3]

bool Spinnaker::GenApi::IsAvailable ( const IBase * p )

inline

Checks if a node is available.

◆ IsAvailable() [3/3]

bool Spinnaker::GenApi::IsAvailable ( EAccessMode AccessMode )

inline

Tests if available.

Examples: BufferHandling.cpp, and StereoAcquisition.cpp.

◆ IsCachable()

virtual bool Spinnaker::GenApi::IsCachable ( ) const

pure virtual

Is the node value cacheable.

◆ IsCacheable()

bool Spinnaker::GenApi::IsCacheable ( ECachingMode CachingMode )

inline

Tests Cacheability.

◆ IsDeprecated()

virtual bool Spinnaker::GenApi::IsDeprecated ( ) const

pure virtual

True if the node should not be used any more.

◆ IsFeature()

virtual bool Spinnaker::GenApi::IsFeature ( ) const

pure virtual

True if the node can be reached via category nodes from a category node named "Root".

◆ IsImplemented() [1/3]

bool Spinnaker::GenApi::IsImplemented ( const IBase & r )

inline

Checks if a node is implemented.

◆ IsImplemented() [2/3]

bool Spinnaker::GenApi::IsImplemented ( const IBase * p )

inline

Checks if a node is implemented.

◆ IsImplemented() [3/3]

bool Spinnaker::GenApi::IsImplemented ( EAccessMode AccessMode )

inline

Tests if implemented.

◆ IsReadable() [1/3]

bool Spinnaker::GenApi::IsReadable ( const IBase & r )

inline

Checks if a node is readable.

◆ IsReadable() [2/3]

bool Spinnaker::GenApi::IsReadable ( const IBase * p )

inline

Checks if a node is readable.

◆ IsReadable() [3/3]

bool Spinnaker::GenApi::IsReadable ( EAccessMode AccessMode )

inline

◆ IsStreamable()

virtual bool Spinnaker::GenApi::IsStreamable ( ) const

pure virtual

True if the node is streamable.

◆ IsVisible()

bool Spinnaker::GenApi::IsVisible	(	EVisibility	Visibility,
		EVisibility	MaxVisiblity
	)

inline

Tests Visibility CAVE : this relies on the EVisibility enum's coding.

◆ IsWritable() [1/3]

bool Spinnaker::GenApi::IsWritable ( const IBase & r )

inline

Checks if a node is writable.

◆ IsWritable() [2/3]

bool Spinnaker::GenApi::IsWritable ( const IBase * p )

inline

Checks if a node is writable.

◆ IsWritable() [3/3]

bool Spinnaker::GenApi::IsWritable ( EAccessMode AccessMode )

inline

◆ operator!=()

virtual bool Spinnaker::GenApi::operator!= ( int nullPtr ) const

pure virtual

◆ operator==()

virtual bool Spinnaker::GenApi::operator== ( int nullPtr ) const

pure virtual

◆ RegisterCallback()

virtual CallbackHandleType Spinnaker::GenApi::RegisterCallback ( CNodeCallback * pCallback )

pure virtual

Register change callback Takes ownership of the CNodeCallback object.

Variable Documentation

◆ INode

interface SPINNAKER_API_ABSTRACT INode

Interface common to all nodes.

Examples: NodeMapCallback.cpp.

◆ IReference

interface SPINNAKER_API_ABSTRACT IReference

Initial value:

{
            
            virtual GenICam::gcstring GetName(bool FullQualified = false) const = 0

Interface to construct a reference.

Functions

Variables

Detailed Description

Function Documentation

◆ Combine() [1/3]

◆ Combine() [2/3]

◆ Combine() [3/3]

◆ DeregisterCallback()

◆ GetAlias()

◆ GetCachingMode()

◆ GetCastAlias()

◆ GetChildren()

◆ GetDescription()

◆ GetDisplayName()

◆ GetDocuURL()

◆ GetEventID()

◆ GetLockNodes()

◆ GetNameSpace()

◆ GetNodeMap()

◆ GetParents()

◆ GetPollingTime()

◆ GetPrincipalInterfaceType()

◆ GetProperty()

◆ GetPropertyNames()

◆ GetVisibility()

◆ ImposeAccessMode()

◆ ImposeVisibility()

◆ InvalidateNode()

◆ IsAccessModeCacheable()

◆ IsAvailable() [1/3]

◆ IsAvailable() [2/3]

◆ IsAvailable() [3/3]

◆ IsCachable()

◆ IsCacheable()

◆ IsDeprecated()

◆ IsFeature()

◆ IsImplemented() [1/3]

◆ IsImplemented() [2/3]

◆ IsImplemented() [3/3]

◆ IsReadable() [1/3]

◆ IsReadable() [2/3]

◆ IsReadable() [3/3]

◆ IsStreamable()

◆ IsVisible()

◆ IsWritable() [1/3]

◆ IsWritable() [2/3]

◆ IsWritable() [3/3]

◆ operator!=()

◆ operator==()

◆ RegisterCallback()

Variable Documentation

◆ INode

◆ IReference