All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
GenApi::IEnumerationT< EnumT > Struct Template Referenceabstract

Interface for enumeration properties. More...

#include <GenApi/IEnumerationT.h>

Inherits IEnumeration.

Inherited by GenApi::CEnumerationTRef< EnumT >.

Public Member Functions

virtual void SetValue (EnumT Value, bool Verify=true)=0
 Set node value. More...
 
virtual IEnumeration & operator= (EnumT Value)=0
 Set node value.
 
virtual EnumT GetValue (bool Verify=false, bool IgnoreCache=false)=0
 Get node value. More...
 
virtual EnumT operator() ()=0
 Get node value.
 
virtual IEnumeration & operator= (const GenICam::gcstring &ValueStr)=0
 Set node value. More...
 
virtual IEnumEntry * GetEntry (const EnumT Value)=0
 returns the EnumEntry object belonging to the Value
 
virtual IEnumEntry * GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0
 Get the current entry.
 

Detailed Description

template<typename EnumT>
struct GenApi::IEnumerationT< EnumT >

Interface for enumeration properties.

Member Function Documentation

template<typename EnumT>
virtual EnumT GenApi::IEnumerationT< EnumT >::GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure 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
template<typename EnumT>
virtual IEnumeration& GenApi::IEnumerationT< EnumT >::operator= ( const GenICam::gcstring ValueStr)
pure virtual

Set node value.

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

template<typename EnumT>
virtual void GenApi::IEnumerationT< EnumT >::SetValue ( EnumT  Value,
bool  Verify = true 
)
pure virtual

Set node value.

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

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

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)