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>

Inheritance diagram for GenApi::IEnumerationT< EnumT >:
Inheritance graph
[legend]

Public Member Functions

virtual void SetValue (EnumT Value, bool Verify=true)=0
 Set node value. More...
 
virtual IEnumerationoperator= (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 IEnumerationoperator= (const GenICam::gcstring &ValueStr)=0
 Set node value. More...
 
virtual IEnumEntryGetEntry (const EnumT Value)=0
 returns the EnumEntry object belonging to the Value
 
virtual IEnumEntryGetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0
 Get the current entry.
 
virtual void GetSymbolics (StringList_t &Symbolics)=0
 Get list of symbolic Values.
 
virtual void GetEntries (NodeList_t &Entries)=0
 Get list of entry nodes.
 
virtual void SetIntValue (int64_t Value, bool Verify=true)=0
 Set integer node value. More...
 
virtual GenICam::gcstring operator* ()=0
 Get string node value.
 
virtual int64_t GetIntValue (bool Verify=false, bool IgnoreCache=false)=0
 Get integer node value. More...
 
virtual IEnumEntryGetEntryByName (const GenICam::gcstring &Symbolic)=0
 Get an entry node by name.
 
virtual IEnumEntryGetEntry (const int64_t IntValue)=0
 Get an entry node by its IntValue.
 
virtual INodeGetNode ()
 Get the INode interface of the node.
 
virtual GenICam::gcstring ToString (bool Verify=false, bool IgnoreCache=false)=0
 Get content of the node as string. More...
 
virtual void FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0
 Set content of the node as string. More...
 
virtual bool IsValueCacheValid () const =0
 Checks if the value comes from cache or is requested from another node.
 
virtual EAccessMode GetAccessMode () const =0
 Get the access mode of the node.
 

Detailed Description

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

Interface for enumeration properties.

Member Function Documentation

virtual void GenApi::IValue::FromString ( const GenICam::gcstring ValueStr,
bool  Verify = true 
)
pure virtualinherited

Set content of the node as string.

Parameters
ValueStrThe value to set
VerifyEnables AccessMode and Range verification (default = true)
virtual int64_t GenApi::IEnumeration::GetIntValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtualinherited

Get integer 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 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

Implements GenApi::IEnumeration.

virtual void GenApi::IEnumeration::SetIntValue ( int64_t  Value,
bool  Verify = true 
)
pure virtualinherited

Set integer node value.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)
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)
virtual GenICam::gcstring GenApi::IValue::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtualinherited

Get content of the node as string.

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

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

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)