Skip to content

GenApi::IEnumEntry#

Module: GenICam / GenApi Node Interfaces and Access Mode Check Functions

Interface of single enum value. More…

#include <GenApi/IEnumEntry.h>

Inherits from GenApi::IValue, GenApi::IBase

Public Functions#

Name
virtual int64_t GetValue()
Get numeric enum value.
virtual GenICam::gcstring GetSymbolic() const
Get symbolic enum value.
virtual double GetNumericValue()
Get double number associated with the entry.
virtual bool IsSelfClearing()
Indicates if the corresponding EnumEntry is self clearing.
virtual INode * GetNode()
Get the INode interface of the node.
virtual GenICam::gcstring ToString(bool Verify =false, bool IgnoreCache =false)
Get content of the node as string.
virtual void FromString(const GenICam::gcstring & ValueStr, bool Verify =true)
Set content of the node as string.
virtual bool IsValueCacheValid() const
Checks if the value comes from cache or is requested from another node.
virtual EAccessMode GetAccessMode() const
Get the access mode of the node.

Additional inherited members#

Public Functions inherited from GenApi::IBase

Name
virtual ~IBase()
Virtual destructor enforcing virtual destructor on all derived classes.

Detailed Description#

struct GenApi::IEnumEntry;

Interface of single enum value.

Maps of Enum Values to symbolic values

Public Functions Documentation#

GetValue#

virtual int64_t GetValue() 

Get numeric enum value.

GetSymbolic#

virtual GenICam::gcstring GetSymbolic() const 

Get symbolic enum value.

GetNumericValue#

virtual double GetNumericValue() 

Get double number associated with the entry.

IsSelfClearing#

virtual bool IsSelfClearing() 

Indicates if the corresponding EnumEntry is self clearing.

GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

Reimplemented by: Pylon::CArrayParameter::GetNode

ToString#

virtual GenICam::gcstring ToString(
    bool Verify =false,
    bool IgnoreCache =false
) 

Get content of the node as string.

Parameters:

  • Verify Enables Range verification (default = false). The AccessMode is always checked
  • IgnoreCache If true the value is read ignoring any caches (default = false)

Return: The value read

Reimplemented by: Pylon::CArrayParameter::ToString

FromString#

virtual void FromString(
    const GenICam::gcstring & ValueStr,
    bool Verify =true
) 

Set content of the node as string.

Parameters:

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

Reimplemented by: Pylon::CArrayParameter::FromString

IsValueCacheValid#

virtual bool IsValueCacheValid() const 

Checks if the value comes from cache or is requested from another node.

Reimplemented by: Pylon::CArrayParameter::IsValueCacheValid

GetAccessMode#

virtual EAccessMode GetAccessMode() const 

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode


Updated on 5 July 2022 at 15:30:01