Class Spinnaker::GenApi::CEnumerationTRef

template <class EnumT>

ClassList > GenApi > CEnumerationTRef

Interface for string properties.

• #include <EnumNodeT.h>

Inherits the following classes: IEnumerationT< EnumT >, Spinnaker::GenApi::EnumNode

Public Functions

Type	Name
	CEnumerationTRef ()
	CEnumerationTRef (std::shared_ptr< Node::NodeImpl > pEnumeration)
virtual IEnumEntry *	GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)
virtual IEnumEntry *	GetEntry (const EnumT Value)
virtual IEnumEntry *	GetEntry (const int64_t IntValue)
virtual EnumT	GetValue (bool Verify=false, bool IgnoreCache=false)
virtual void	SetEnumReference (int Index, GenICam::gcstring Name)
virtual void	SetNumEnums (int NumEnums)
virtual void	SetReference (INode * pBase)
virtual void	SetValue (EnumT Value, bool Verify=true)
virtual EnumT	operator() ()
virtual IEnumeration &	operator= (EnumT Value)
virtual IEnumeration &	operator= (const GenICam::gcstring & ValueStr)
virtual	~CEnumerationTRef ()

Public Functions inherited from Spinnaker::GenApi::EnumNode

See Spinnaker::GenApi::EnumNode

Type	Name
	EnumNode ()
	EnumNode (std::shared_ptr< Node::NodeImpl > pEnumeration)
virtual IEnumEntry *	GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)
virtual void	GetEntries (NodeList_t & Entries)
virtual IEnumEntry *	GetEntry (const int64_t IntValue)
virtual IEnumEntry *	GetEntryByName (const GenICam::gcstring & Symbolic)
virtual int64_t	GetIntValue (bool Verify=false, bool IgnoreCache=false)
virtual void	GetSymbolics (StringList_t & Symbolics)
virtual void	SetIntValue (int64_t Value, bool Verify=true)
virtual void	SetReference (INode * pBase)
virtual GenICam::gcstring	operator* ()
virtual IEnumeration &	operator= (const GenICam::gcstring & ValueStr)
virtual	~EnumNode ()

Public Functions inherited from Spinnaker::GenApi::ValueNode

See Spinnaker::GenApi::ValueNode

Type	Name
virtual void	FromString (const GenICam::gcstring & ValueStr, bool Verify=true)
virtual INode *	GetNode ()
virtual bool	IsValueCacheValid () const
virtual bool	IsValueUpdated ()
virtual void	SetReference (INode * pBase)
virtual GenICam::gcstring	ToString (bool Verify=false, bool IgnoreCache=false)
	ValueNode ()
	ValueNode (std::shared_ptr< Node::NodeImpl > pValue)
	~ValueNode ()

Public Functions inherited from Spinnaker::GenApi::Node

See Spinnaker::GenApi::Node

Type	Name
virtual bool	DeregisterCallback (CallbackHandleType hCallback)
virtual EAccessMode	GetAccessMode () const Base interface overrides.
virtual INode *	GetAlias () const
virtual ECachingMode	GetCachingMode () const
virtual INode *	GetCastAlias () const
virtual void	GetChildren (GenApi::NodeList_t & Children, ELinkType LinkType=ctReadingChildren) const Get all nodes this node directly depends on.
virtual GenICam::gcstring	GetDescription () const
virtual GenICam::gcstring	GetDeviceName () const
virtual GenICam::gcstring	GetDisplayName () const
virtual GenICam::gcstring	GetDocuURL () const
virtual GenICam::gcstring	GetEventID () const
virtual void	GetLockNodes (GenApi::NodeList_t & LockNodes) const Gets all nodes which can directly lock this node.
virtual GenICam::gcstring	GetName (bool FullQualified=false) const
virtual GenApi::ENameSpace	GetNameSpace () const
std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
virtual INodeMap *	GetNodeMap () const
virtual void	GetParents (GenApi::NodeList_t & Parents) const Gets all nodes this node is directly depending on.
virtual int64_t	GetPollingTime () const
virtual EInterfaceType	GetPrincipalInterfaceType () const
virtual bool	GetProperty (const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr)
virtual void	GetPropertyNames (GenICam::gcstring_vector & PropertyNames) const
virtual void	GetSelectedFeatures (FeatureList_t &) const
virtual void	GetSelectingFeatures (FeatureList_t &) const
virtual GenICam::gcstring	GetToolTip () const
virtual EVisibility	GetVisibility () const
virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode)
virtual void	ImposeVisibility (EVisibility ImposedVisibility)
virtual void	InvalidateNode ()
virtual EYesNo	IsAccessModeCacheable () const
virtual bool	IsCachable () const
virtual bool	IsDeprecated () const
virtual bool	IsFeature () const
virtual bool	IsSelector () const Selector interface overrides.
virtual bool	IsStreamable () const
	Node ()
	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
virtual CallbackHandleType	RegisterCallback (CNodeCallback * pCallback)
void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
void	SetNodeMap (INodeMap * pNodeMap)
virtual void	SetReference (INode * pBase) Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void	SetReference (ISelector * pBase)
virtual bool	operator!= (int nullPtr) const
virtual bool	operator== (int nullPtr) const
	~Node ()

Protected Attributes inherited from Spinnaker::GenApi::EnumNode

See Spinnaker::GenApi::EnumNode

Type	Name
std::shared_ptr< Node::NodeImpl >	m_pEnumeration

Protected Attributes inherited from Spinnaker::GenApi::Node

See Spinnaker::GenApi::Node

Type	Name
std::list< CallbackHandleType_t * >	m_Callbacks
std::shared_ptr< Node::NodeImpl >	m_pNodeData
INodeMap *	m_pNodeMap

Public Functions Documentation

function CEnumerationTRef [1/2]

GenApi::CEnumerationTRef::CEnumerationTRef () 

---

function CEnumerationTRef [2/2]

GenApi::CEnumerationTRef::CEnumerationTRef (
    std::shared_ptr< Node::NodeImpl > pEnumeration
) 

---

function GetCurrentEntry

virtual IEnumEntry * GenApi::CEnumerationTRef::GetCurrentEntry (
    bool Verify=false,
    bool IgnoreCache=false
) 

Get the current entry

Implements Spinnaker::GenApi::EnumNode::GetCurrentEntry

---

function GetEntry [1/2]

virtual IEnumEntry * GenApi::CEnumerationTRef::GetEntry (
    const  EnumT Value
) 

returns the EnumEntry object belonging to the Value

---

function GetEntry [2/2]

virtual IEnumEntry * GenApi::CEnumerationTRef::GetEntry (
    const  int64_t IntValue
) 

Get an entry node by its IntValue

Implements Spinnaker::GenApi::EnumNode::GetEntry

---

function GetValue

virtual EnumT GenApi::CEnumerationTRef::GetValue (
    bool Verify=false,
    bool IgnoreCache=false
) 

Get 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

---

function SetEnumReference

virtual void GenApi::CEnumerationTRef::SetEnumReference (
    int Index,
    GenICam::gcstring Name
) 

sets the Enum value corresponding to a value

---

function SetNumEnums

virtual void GenApi::CEnumerationTRef::SetNumEnums (
    int NumEnums
) 

sets the number of enum values

---

function SetReference

virtual void GenApi::CEnumerationTRef::SetReference (
    INode * pBase
) 

overload SetReference for EnumerationT

Implements Spinnaker::GenApi::EnumNode::SetReference

---

function SetValue

virtual void GenApi::CEnumerationTRef::SetValue (
    EnumT Value,
    bool Verify=true
) 

Set node value

Parameters:

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

---

function operator()

virtual EnumT GenApi::CEnumerationTRef::operator() () 

Get node value

---

function operator=

virtual IEnumeration & GenApi::CEnumerationTRef::operator= (
    EnumT Value
) 

Set node value

---

function operator=

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

Set node value

Note : the operator= is not inherited thus the operator= versions from IEnumeration must be implemented again

Implements Spinnaker::GenApi::EnumNode::operator=

---

function ~CEnumerationTRef

virtual GenApi::CEnumerationTRef::~CEnumerationTRef () 

---

---

The documentation for this class was generated from the following file /workspace/include/SpinGenApi/EnumNodeT.h