Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
CEnumerationTRef< EnumT > Class Template Reference

Interface for string properties. More...

Inheritance diagram for CEnumerationTRef< EnumT >:
EnumNode ValueNode Node

Public Member Functions

 CEnumerationTRef ()
 
 CEnumerationTRef (std::shared_ptr< Node::NodeImpl > pEnumeration)
 
virtual ~CEnumerationTRef ()
 
virtual void SetValue (EnumT Value, bool Verify=true)
 Set node value. More...
 
virtual IEnumerationoperator= (EnumT Value)
 Set node value. More...
 
virtual EnumT GetValue (bool Verify=false, bool IgnoreCache=false)
 Get node value. More...
 
virtual EnumT operator() ()
 Get node value. More...
 
virtual IEnumerationoperator= (const GenICam::gcstring &ValueStr)
 Set node value. More...
 
virtual IEnumEntryGetEntry (const EnumT Value)
 returns the EnumEntry object belonging to the Value More...
 
virtual IEnumEntryGetEntry (const int64_t IntValue)
 Get an entry node by its IntValue. More...
 
virtual IEnumEntryGetCurrentEntry (bool Verify=false, bool IgnoreCache=false)
 Get the current entry. More...
 
virtual void SetReference (INode *pBase)
 overload SetReference for EnumerationT More...
 
virtual void SetEnumReference (int Index, GenICam::gcstring Name)
 sets the Enum value corresponding to a value More...
 
virtual void SetNumEnums (int NumEnums)
 sets the number of enum values More...
 
- Public Member Functions inherited from EnumNode
 EnumNode ()
 
 EnumNode (std::shared_ptr< Node::NodeImpl > pEnumeration)
 
virtual ~EnumNode ()
 
virtual void GetSymbolics (StringList_t &Symbolics)
 Get list of symbolic Values. More...
 
virtual void GetEntries (NodeList_t &Entries)
 Get list of entry nodes. More...
 
virtual void SetIntValue (int64_t Value, bool Verify=true)
 Set integer node value. More...
 
virtual GenICam::gcstring operator* ()
 Get string node value. More...
 
virtual int64_t GetIntValue (bool Verify=false, bool IgnoreCache=false)
 Get integer node value. More...
 
virtual IEnumEntryGetEntryByName (const GenICam::gcstring &Symbolic)
 Get an entry node by name. More...
 
- Public Member Functions inherited from ValueNode
 ValueNode ()
 Constructor. More...
 
 ValueNode (std::shared_ptr< Node::NodeImpl > pValue)
 constructor with GenICam IValue More...
 
 ~ValueNode ()
 Destructor. More...
 
virtual INodeGetNode ()
 
virtual GenICam::gcstring ToString (bool Verify=false, bool IgnoreCache=false)
 Get content of the node as string. More...
 
virtual void FromString (const GenICam::gcstring &ValueStr, bool Verify=true)
 Set content of the node as string. More...
 
virtual bool IsValueCacheValid () const
 Checks if the value comes from cache or is requested from another node. More...
 
- Public Member Functions inherited from Node
 Node ()
 Constructor. More...
 
 Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Constructor. More...
 
 ~Node ()
 Destructor. More...
 
virtual GenICam::gcstring GetName (bool FullQualified=false) const
 Get node name. More...
 
virtual GenApi::ENameSpace GetNameSpace () const
 Get name space. More...
 
virtual EVisibility GetVisibility () const
 Get the recommended visibility of the node. More...
 
virtual void InvalidateNode ()
 Indicates that the node's value may have changed. More...
 
virtual bool IsCachable () const
 Is the node value cacheable. More...
 
virtual EYesNo IsAccessModeCacheable () const
 True if the AccessMode can be cached. More...
 
virtual ECachingMode GetCachingMode () const
 Get Caching Mode. More...
 
virtual int64_t GetPollingTime () const
 recommended polling time (for not cacheable nodes) More...
 
virtual GenICam::gcstring GetToolTip () const
 Get a short description of the node. More...
 
virtual GenICam::gcstring GetDescription () const
 Get a long description of the node. More...
 
virtual GenICam::gcstring GetDisplayName () const
 Get a name string for display. More...
 
virtual GenICam::gcstring GetDeviceName () const
 Get a name of the device. More...
 
virtual void GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const
 Get all nodes this node directly depends on. More...
 
virtual void GetParents (GenApi::NodeList_t &Parents) const
 Gets all nodes this node is directly depending on. More...
 
virtual CallbackHandleType RegisterCallback (CNodeCallback *pCallback)
 Register change callback Takes ownership of the CNodeCallback object. More...
 
virtual bool DeregisterCallback (CallbackHandleType hCallback)
 De register change callback Destroys CNodeCallback object. More...
 
virtual INodeMapGetNodeMap () const
 Retrieves the central node map. More...
 
virtual GenICam::gcstring GetEventID () const
 Get the EventId of the node. More...
 
virtual bool IsStreamable () const
 True if the node is streamable. More...
 
virtual void GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const
 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)
 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)
 Imposes an access mode to the natural access mode of the node. More...
 
virtual void ImposeVisibility (EVisibility ImposedVisibility)
 Imposes a visibility to the natural visibility of the node. More...
 
virtual INodeGetAlias () const
 Retrieves the a node which describes the same feature in a different way. More...
 
virtual INodeGetCastAlias () const
 Retrieves the a node which describes the same feature so that it can be casted. More...
 
virtual GenICam::gcstring GetDocuURL () const
 Gets a URL pointing to the documentation of that feature. More...
 
virtual bool IsDeprecated () const
 True if the node should not be used any more. More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a node. More...
 
virtual bool IsFeature () const
 True if the node can be reached via category nodes from a category node named "Root". More...
 
void SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Set Node handle. More...
 
std::shared_ptr< Node::NodeImpl > GetNodeHandle () const
 Get Node handle. More...
 
virtual EAccessMode GetAccessMode () const
 Base interface overrides. More...
 
virtual bool IsSelector () const
 Selector interface overrides. More...
 
virtual void GetSelectedFeatures (FeatureList_t &) const
 retrieve the group of selected features More...
 
virtual void GetSelectingFeatures (FeatureList_t &) const
 retrieve the group of features selecting this node More...
 
virtual void SetReference (ISelector *pBase)
 
void SetNodeMap (INodeMap *pNodeMap)
 
virtual bool operator== (int nullPtr) const
 
virtual bool operator!= (int nullPtr) const
 

Additional Inherited Members

- Protected Attributes inherited from EnumNode
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. More...
 
INodeMapm_pNodeMap
 

Detailed Description

template<class EnumT>
class Spinnaker::GenApi::CEnumerationTRef< EnumT >

Interface for string properties.

Constructor & Destructor Documentation

CEnumerationTRef ( std::shared_ptr< Node::NodeImpl >  pEnumeration)
virtual ~CEnumerationTRef ( )
virtual

Member Function Documentation

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

Get the current entry.

Reimplemented from EnumNode.

virtual IEnumEntry* GetEntry ( const EnumT  Value)
virtual

returns the EnumEntry object belonging to the Value

virtual IEnumEntry* GetEntry ( const int64_t  IntValue)
virtual

Get an entry node by its IntValue.

Reimplemented from EnumNode.

virtual EnumT GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
virtual

Get node value.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read
virtual EnumT operator() ( )
virtual

Get node value.

virtual IEnumeration& operator= ( EnumT  Value)
virtual

Set node value.

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

Set node value.

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

Reimplemented from EnumNode.

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

sets the Enum value corresponding to a value

virtual void SetNumEnums ( int  NumEnums)
virtual

sets the number of enum values

virtual void SetReference ( INode pBase)
virtual

overload SetReference for EnumerationT

Reimplemented from EnumNode.

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

Set node value.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference