Skip to content

GenApi::CIntegerRefT#

More…

Inherits from GenApi::CValueRefT< T, I >

Public Functions#

Name
virtual void SetValue(int64_t Value, bool Verify =true)
Set node value.
virtual IInteger & operator=(int64_t Value)
Set node value.
virtual int64_t GetValue(bool Verify =false, bool IgnoreCache =false)
Get node value.
virtual int64_t operator()()
Get node value.
virtual int64_t operator*()
Get node value.
virtual int64_t GetMin()
Get minimum value allowed.
virtual int64_t GetMax()
Get maximum value allowed.
virtual EIncMode GetIncMode()
Get increment.
virtual int64_t GetInc()
Get increment.
virtual int64_autovector_t GetListOfValidValues(bool bounded =true)
Implementation of IInteger::GetListOfValidValues.
virtual ERepresentation GetRepresentation()
Get recommended representation.
virtual GenICam::gcstring GetUnit()
Get the physical unit name.
IFloat * GetFloatAlias()
gets the interface of an alias node.
virtual void ImposeMin(int64_t Value)
Restrict minimum value.
virtual void ImposeMax(int64_t Value)
Restrict maximum value.
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.

Detailed Description#

template <class T ,
class I  =T>
class GenApi::CIntegerRefT;

Public Functions Documentation#

SetValue#

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

Set node value.

operator=#

inline virtual IInteger & operator=(
    int64_t Value
)

Set node value.

GetValue#

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

Get node value.

operator()#

inline virtual int64_t operator()()

Get node value.

operator*#

inline virtual int64_t operator*()

Get node value.

GetMin#

inline virtual int64_t GetMin()

Get minimum value allowed.

GetMax#

inline virtual int64_t GetMax()

Get maximum value allowed.

GetIncMode#

inline virtual EIncMode GetIncMode()

Get increment.

GetInc#

inline virtual int64_t GetInc()

Get increment.

GetListOfValidValues#

inline virtual int64_autovector_t GetListOfValidValues(
    bool bounded =true
)

Implementation of IInteger::GetListOfValidValues.

GetRepresentation#

inline virtual ERepresentation GetRepresentation()

Get recommended representation.

GetUnit#

inline virtual GenICam::gcstring GetUnit()

Get the physical unit name.

GetFloatAlias#

inline IFloat * GetFloatAlias()

gets the interface of an alias node.

ImposeMin#

inline virtual void ImposeMin(
    int64_t Value
)

Restrict minimum value.

ImposeMax#

inline virtual void ImposeMax(
    int64_t Value
)

Restrict maximum value.

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 virtual bool IsValueCacheValid() const

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

GetAccessMode#

inline virtual EAccessMode GetAccessMode() const

Get the access mode of the node.


Updated on 5 July 2022 at 15:30:00