Skip to content

GenApi::CEnumerationTRef#

More…

Inherits from GenApi::IEnumerationT< EnumT >, IReference, IEnumReference, GenApi::IEnumeration, GenApi::IValue, GenApi::IBase

Public Functions#

Name
virtual void SetReference(IBase * ptr)
sets the implementation to the reference
virtual void SetNumEnums(int NumEnums)
sets the number of enum values
virtual void SetEnumReference(int Index, GenICam::gcstring Name)
sets the Enum value corresponding to a value
virtual EAccessMode GetAccessMode() const
Get the access mode of the node.
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.
bool IsValueCacheValid() const
Checks if the value comes from cache or is requested from another node.
virtual void GetSymbolics(StringList_t & Symbolics)
Get list of symbolic Values.
virtual void GetEntries(NodeList_t & Entries)
Get list of entry nodes.
virtual IEnumeration & operator=(const GenICam::gcstring & ValueStr)
Set node value.
virtual IEnumeration & operator=(const char * pValueStr)
Set node value.
virtual void SetIntValue(int64_t Value, bool Verify =true)
Set node value.
virtual GenICam::gcstring operator*()
Get node value.
virtual int64_t GetIntValue(bool Verify =false, bool IgnoreCache =false)
Get 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 IEnumEntry * GetCurrentEntry(bool Verify =false, bool IgnoreCache =false)
Get the current entry.
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 IEnumEntry * GetEntry(const EnumT Value)
returns the EnumEntry object belonging to the Value

Protected Attributes#

Name
IEnumeration * m_Ptr
Pointer to the implementation the reference references to.
std::vector< int64_t > m_EnumValues
The values for enums with a given index.
std::vector< bool > m_EnumExists
Indicates it an enum with a given index exists.

Additional inherited members#

Public Functions inherited from GenApi::IBase

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

Detailed Description#

template <class EnumT >
class GenApi::CEnumerationTRef;

Public Functions Documentation#

SetReference#

inline virtual void SetReference(
    IBase * ptr
)

sets the implementation to the reference

SetNumEnums#

inline virtual void SetNumEnums(
    int NumEnums
)

sets the number of enum values

SetEnumReference#

inline virtual void SetEnumReference(
    int Index,
    GenICam::gcstring Name
)

sets the Enum value corresponding to a value

GetAccessMode#

inline virtual EAccessMode GetAccessMode() const

Get the access mode of the node.

GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

ToString#

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

Get content of the node as string.

FromString#

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

Set content of the node as string.

IsValueCacheValid#

inline bool IsValueCacheValid() const

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

GetSymbolics#

inline virtual void GetSymbolics(
    StringList_t & Symbolics
)

Get list of symbolic Values.

GetEntries#

inline virtual void GetEntries(
    NodeList_t & Entries
)

Get list of entry nodes.

operator=#

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

Set node value.

operator=#

inline virtual IEnumeration & operator=(
    const char * pValueStr
)

Set node value.

SetIntValue#

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

Set node value.

operator*#

inline virtual GenICam::gcstring operator*()

Get node value.

GetIntValue#

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

Get node value.

GetEntryByName#

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

Get an entry node by name.

GetEntry#

inline virtual IEnumEntry * GetEntry(
    const int64_t IntValue
)

Get an entry node by its IntValue.

GetCurrentEntry#

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

Get the current entry.

SetValue#

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

Set node value.

operator=#

inline virtual IEnumeration & operator=(
    EnumT Value
)

Set node value.

GetValue#

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

Get node value.

operator()#

inline virtual EnumT operator()()

Get node value.

GetEntry#

inline virtual IEnumEntry * GetEntry(
    const EnumT Value
)

returns the EnumEntry object belonging to the Value

Protected Attributes Documentation#

m_Ptr#

IEnumeration * m_Ptr;

Pointer to the implementation the reference references to.

m_EnumValues#

std::vector< int64_t > m_EnumValues;

The values for enums with a given index.

m_EnumExists#

std::vector< bool > m_EnumExists;

Indicates it an enum with a given index exists.


Updated on 27 July 2022 at 19:03:46