Interface for string properties. More...

#include <EnumNode.h>

Inheritance diagram for EnumNode:

Public Member Functions
	EnumNode ()

	EnumNode (std::shared_ptr< Node::NodeImpl > pEnumeration)

virtual	~EnumNode ()

virtual void	GetSymbolics (StringList_t &Symbolics)
	Get list of symbolic Values.

virtual void	GetEntries (NodeList_t &Entries)
	Get list of entry nodes.

virtual IEnumeration &	operator= (const GenICam::gcstring &ValueStr)
	Set string node value.

virtual void	SetIntValue (int64_t Value, bool Verify=true)
	Set integer node value.

virtual GenICam::gcstring	operator* ()
	Get string node value.

virtual int64_t	GetIntValue (bool Verify=false, bool IgnoreCache=false)
	Get integer node value.

virtual IEnumEntry *	GetEntryByName (const GenICam::gcstring &Symbolic)
	Get an entry node by name.

virtual IEnumEntry *	GetEntry (const int64_t IntValue)
	Get an entry node by its IntValue.

virtual IEnumEntry *	GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)
	Get the current entry.

virtual void	SetReference (INode *pBase)
	overload SetReference for Enumeration

Public Member Functions inherited from ValueNode
	ValueNode ()
	Constructor.

	ValueNode (std::shared_ptr< Node::NodeImpl > pValue)
	constructor with GenICam IValue

	~ValueNode ()
	Destructor.

virtual INode *	GetNode ()

virtual GenICam::gcstring	ToString (bool Verify=false, bool IgnoreCache=false)
	Get content of the node as string.

virtual void	FromString (const GenICam::gcstring &ValueStr, bool Verify=true)
	Set content of the node as string.

virtual bool	IsValueCacheValid () const
	Checks if the value comes from cache or is requested from another node.

virtual void	SetReference (INode *pBase)
	overload SetReference for Value

Public Member Functions inherited from Node
	Node ()
	Constructor.

	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
	Constructor.

	~Node ()
	Destructor.

virtual GenICam::gcstring	GetName (bool FullQualified=false) const
	Get node name.

virtual GenApi::ENameSpace	GetNameSpace () const
	Get name space.

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

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

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

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

virtual ECachingMode	GetCachingMode () const
	Get Caching Mode.

virtual int64_t	GetPollingTime () const
	recommended polling time (for not cacheable nodes)

virtual GenICam::gcstring	GetToolTip () const
	Get a short description of the node.

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

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

virtual GenICam::gcstring	GetDeviceName () const
	Get a name of the device.

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
	Set Node handle.

std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
	Get Node handle.

virtual EAccessMode	GetAccessMode () const
	Base interface overrides.

virtual bool	IsSelector () const
	Selector interface overrides.

virtual void	GetSelectedFeatures (FeatureList_t &) const
	retrieve the group of selected features

virtual void	GetSelectingFeatures (FeatureList_t &) const
	retrieve the group of features selecting this node

virtual void	SetReference (INode *pBase)
	Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

virtual void	SetReference (ISelector *pBase)

void	SetNodeMap (INodeMap *pNodeMap)

virtual bool	operator== (int nullPtr) const

virtual bool	operator!= (int nullPtr) const

Protected Attributes
std::shared_ptr< Node::NodeImpl >	m_pEnumeration

Protected Attributes inherited from Node
std::shared_ptr< Node::NodeImpl >	m_pNodeData

std::list< CallbackHandleType_t * >	m_Callbacks
	List of callbacks.

INodeMap *	m_pNodeMap

Detailed Description

Interface for string properties.

Constructor & Destructor Documentation

◆ EnumNode() [1/2]

EnumNode ( )

◆ EnumNode() [2/2]

EnumNode ( std::shared_ptr< Node::NodeImpl > pEnumeration )

◆ ~EnumNode()

virtual ~EnumNode ( )

virtual

Member Function Documentation

◆ GetCurrentEntry()

virtual IEnumEntry * GetCurrentEntry	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

virtual

Get the current entry.

Reimplemented in CEnumerationTRef< EnumT >.

◆ GetEntries()

virtual void GetEntries ( NodeList_t & Entries )

virtual

Get list of entry nodes.

◆ GetEntry()

virtual IEnumEntry * GetEntry ( const int64_t IntValue )

virtual

Get an entry node by its IntValue.

Reimplemented in CEnumerationTRef< EnumT >.

◆ GetEntryByName()

virtual IEnumEntry * GetEntryByName ( const GenICam::gcstring & Symbolic )

virtual

Get an entry node by name.

◆ GetIntValue()

virtual int64_t GetIntValue	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

virtual

Get integer node value.

Parameters

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

◆ GetSymbolics()

virtual void GetSymbolics ( StringList_t & Symbolics )

virtual

Get list of symbolic Values.

◆ operator*()

virtual GenICam::gcstring operator* ( )

virtual

Get string node value.

◆ operator=()

virtual IEnumeration & operator= ( const GenICam::gcstring & ValueStr )

virtual

Set string node value.

Reimplemented in CEnumerationTRef< EnumT >.

◆ SetIntValue()

virtual void SetIntValue	(	int64_t	Value,
		bool	Verify = `true`
	)

virtual

Set integer node value.

Parameters

Value	The value to set
Verify	Enables AccessMode and Range verification (default = true)

◆ SetReference()

virtual void SetReference ( INode * pBase )

virtual

overload SetReference for Enumeration

Reimplemented from ValueNode.

Reimplemented in CEnumerationTRef< EnumT >.

Member Data Documentation

◆ m_pEnumeration

std::shared_ptr<Node::NodeImpl> m_pEnumeration

protected

The documentation for this class was generated from the following file:

include/SpinGenApi/EnumNode.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EnumNode() [1/2]

◆ EnumNode() [2/2]

◆ ~EnumNode()

Member Function Documentation

◆ GetCurrentEntry()

◆ GetEntries()

◆ GetEntry()

◆ GetEntryByName()

◆ GetIntValue()

◆ GetSymbolics()

◆ operator*()

◆ operator=()

◆ SetIntValue()

◆ SetReference()

Member Data Documentation

◆ m_pEnumeration