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) =0 Set node value.
virtual IEnumeration &	operator=(EnumT Value) =0 Set node value.
virtual EnumT	GetValue(bool Verify =false, bool IgnoreCache =false) =0 Get node value.
virtual EnumT	operator())() =0 Get node value.
virtual IEnumeration &	operator=(const GenICam::gcstring & ValueStr) =0 Set node value.
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.
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.
virtual GenICam::gcstring	operator*() =0 Get string node value.
virtual int64_t	GetIntValue(bool Verify =false, bool IgnoreCache =false) =0 Get integer node value.
virtual IEnumEntry *	GetEntryByName(const GenICam::gcstring & Symbolic) =0 Get an entry node by name.
virtual IEnumEntry *	GetEntry(const int64_t IntValue) =0 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) =0 Get content of the node as string.
virtual void	FromString(const GenICam::gcstring & ValueStr, bool Verify =true) =0 Set content of the node as string.
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.

Additional inherited members#

Public Functions inherited from GenApi::IBase

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

Detailed Description#

template <typename EnumT >
struct GenApi::IEnumerationT;

Interface for enumeration properties.

Public Functions Documentation#

function SetValue#

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

Set node value.

Parameters:

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

function operator=#

virtual IEnumeration & operator=(
    EnumT Value
) =0

Set node value.

function GetValue#

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

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

function operator()#

virtual EnumT operator()() =0

Get node value.

function operator=#

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

Set node value.

Reimplements: GenApi::IEnumeration::operator=

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

function GetEntry#

virtual IEnumEntry * GetEntry(
    const EnumT Value
) =0

returns the EnumEntry object belonging to the Value

function GetCurrentEntry#

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

Get the current entry.

Reimplements: GenApi::IEnumeration::GetCurrentEntry

function GetSymbolics#

virtual void GetSymbolics(
    StringList_t & Symbolics
) =0

Get list of symbolic Values.

Reimplemented by: Pylon::CEnumParameter::GetSymbolics

function GetEntries#

virtual void GetEntries(
    NodeList_t & Entries
) =0

Get list of entry nodes.

Reimplemented by: Pylon::CEnumParameter::GetEntries

function SetIntValue#

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

Set integer node value.

Parameters:

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

Reimplemented by: Pylon::CEnumParameter::SetIntValue

function operator*#

virtual GenICam::gcstring operator*() =0

Get string node value.

Reimplemented by: Pylon::CEnumParameter::operator*

function GetIntValue#

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

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

function GetEntryByName#

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

Get an entry node by name.

Reimplemented by: Pylon::CEnumParameter::GetEntryByName

function GetEntry#

virtual IEnumEntry * GetEntry(
    const int64_t IntValue
) =0

Get an entry node by its IntValue.

Reimplemented by: Pylon::CEnumParameter::GetEntry

function GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

Reimplemented by: Pylon::CArrayParameter::GetNode

function ToString#

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

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

function FromString#

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

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

function IsValueCacheValid#

virtual bool IsValueCacheValid() const =0

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

Reimplemented by: Pylon::CArrayParameter::IsValueCacheValid

function GetAccessMode#

virtual EAccessMode GetAccessMode() const =0

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode