Pylon Logo Basler Logo
Public Member Functions | List of all members
GenApi::IEnumeration Struct Referenceabstract

Interface for enumeration properties. More...

#include <GenApi/IEnumeration.h>

Inheritance diagram for GenApi::IEnumeration:
Inheritance graph
[legend]

Public Member Functions

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 IEnumerationoperator= (const GenICam::gcstring &ValueStr)=0
 Set string node value.
 
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 IEnumEntryGetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0
 Get the current entry.
 
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

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)

Implemented in Pylon::CParameter.

virtual int64_t GenApi::IEnumeration::GetIntValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

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

Implemented in Pylon::CEnumParameter.

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

Set integer node value.

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

Implemented in Pylon::CEnumParameter.

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

Implemented in Pylon::CParameter.


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

pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:56:56)