Skip to content

GenApi::IEnumerationT#

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

Interface for enumeration properties. More…

#include <GenApi/IEnumerationT.h>

Inherits from GenApi::IEnumeration, GenApi::IValue, GenApi::IBase

Inherited by GenApi::CEnumerationTRef< EnumT >

Public Functions#

Name
virtual void SetValue(EnumT Value, bool Verify =true)
Set node value.
virtual IEnumeration & operator=(EnumT Value)
Set node value.
virtual EnumT GetValue(bool Verify =false, bool IgnoreCache =false)
Get node value.
virtual EnumT operator()()
Get node value.
virtual IEnumeration & operator=(const GenICam::gcstring & ValueStr)
Set node value.
virtual IEnumEntry * GetEntry(const EnumT Value)
returns the EnumEntry object belonging to the Value
virtual IEnumEntry * GetCurrentEntry(bool Verify =false, bool IgnoreCache =false)
Get the current entry.
virtual void GetSymbolics(StringList_t & Symbolics)
Get list of symbolic Values.
virtual void GetEntries(NodeList_t & Entries)
Get list of entry nodes.
virtual void SetIntValue(int64_t Value, bool Verify =true)
Set integer node value.
virtual GenICam::gcstring operator*()
Get string node value.
virtual int64_t GetIntValue(bool Verify =false, bool IgnoreCache =false)
Get integer node value.
virtual IEnumEntry * GetEntryByName(const GenICam::gcstring & Symbolic)
Get an entry node by name.
virtual IEnumEntry * GetEntry(const int64_t IntValue)
Get an entry node by its IntValue.
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#

template <typename EnumT >
struct GenApi::IEnumerationT;

Interface for enumeration properties.

Public Functions Documentation#

SetValue#

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

Set node value.

Parameters:

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

operator=#

virtual IEnumeration & operator=(
    EnumT Value
) 

Set node value.

GetValue#

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

Get node value.

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

operator()#

virtual EnumT operator()() 

Get node value.

operator=#

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

Set node value.

Reimplements: GenApi::IEnumeration::operator=

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

GetEntry#

virtual IEnumEntry * GetEntry(
    const EnumT Value
) 

returns the EnumEntry object belonging to the Value

GetCurrentEntry#

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

Get the current entry.

Reimplements: GenApi::IEnumeration::GetCurrentEntry

GetSymbolics#

virtual void GetSymbolics(
    StringList_t & Symbolics
) 

Get list of symbolic Values.

Reimplemented by: Pylon::CEnumParameter::GetSymbolics

GetEntries#

virtual void GetEntries(
    NodeList_t & Entries
) 

Get list of entry nodes.

Reimplemented by: Pylon::CEnumParameter::GetEntries

SetIntValue#

virtual void SetIntValue(
    int64_t Value,
    bool Verify =true
) 

Set integer node value.

Parameters:

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

Reimplemented by: Pylon::CEnumParameter::SetIntValue

operator*#

virtual GenICam::gcstring operator*() 

Get string node value.

Reimplemented by: Pylon::CEnumParameter::operator*

GetIntValue#

virtual int64_t GetIntValue(
    bool Verify =false,
    bool IgnoreCache =false
) 

Get integer node value.

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::CEnumParameter::GetIntValue

GetEntryByName#

virtual IEnumEntry * GetEntryByName(
    const GenICam::gcstring & Symbolic
) 

Get an entry node by name.

Reimplemented by: Pylon::CEnumParameter::GetEntryByName

GetEntry#

virtual IEnumEntry * GetEntry(
    const int64_t IntValue
) 

Get an entry node by its IntValue.

Reimplemented by: Pylon::CEnumParameter::GetEntry

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 27 July 2022 at 19:03:47