GenApi::CFloatRefT#

Inherits from GenApi::CValueRefT< T >

Public Functions#

	Name
virtual void	SetValue(double Value, bool Verify =true) Set node value.
virtual IFloat &	operator=(double Value) Set node value.
virtual double	GetValue(bool Verify =false, bool IgnoreCache =false) Get node value.
virtual double	operator())() Get node value.
virtual double	operator*() Get node value.
virtual double	GetMin() Get minimum value allowed.
virtual double	GetMax() Get maximum value allowed.
virtual bool	HasInc() True if the float has a constant increment.
virtual double	GetInc() Get the constant increment if there is any.
virtual double_autovector_t	GetListOfValidValues(bool bounded =true) Get list of valid value.
virtual ERepresentation	GetRepresentation() Get recommended representation.
virtual GenICam::gcstring	GetUnit() const Get unit.
virtual EDisplayNotation	GetDisplayNotation() const Get the way the float should be converted to a string.
virtual int64_t	GetDisplayPrecision() const Get the precision to be used when converting the float to a string.
IInteger *	GetIntAlias() gets the interface of an alias node.
IEnumeration *	GetEnumAlias() gets the interface of an alias node.
virtual void	ImposeMin(double Value) Restrict minimum value.
virtual void	ImposeMax(double 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 GenApi::CFloatRefT;

Public Functions Documentation#

function SetValue#

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

Set node value.

function operator=#

inline virtual IFloat & operator=(
    double Value
)

Set node value.

function GetValue#

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

Get node value.

function operator()#

inline virtual double operator()()

Get node value.

function operator*#

inline virtual double operator*()

Get node value.

function GetMin#

inline virtual double GetMin()

Get minimum value allowed.

function GetMax#

inline virtual double GetMax()

Get maximum value allowed.

function HasInc#

inline virtual bool HasInc()

True if the float has a constant increment.

function GetInc#

inline virtual double GetInc()

Get the constant increment if there is any.

function GetListOfValidValues#

inline virtual double_autovector_t GetListOfValidValues(
    bool bounded =true
)

Get list of valid value.

function GetRepresentation#

inline virtual ERepresentation GetRepresentation()

Get recommended representation.

function GetUnit#

inline virtual GenICam::gcstring GetUnit() const

Get unit.

function GetDisplayNotation#

inline virtual EDisplayNotation GetDisplayNotation() const

Get the way the float should be converted to a string.

function GetDisplayPrecision#

inline virtual int64_t GetDisplayPrecision() const

Get the precision to be used when converting the float to a string.

function GetIntAlias#

inline IInteger * GetIntAlias()

gets the interface of an alias node.

function GetEnumAlias#

inline IEnumeration * GetEnumAlias()

gets the interface of an alias node.

function ImposeMin#

inline virtual void ImposeMin(
    double Value
)

Restrict minimum value.

function ImposeMax#

inline virtual void ImposeMax(
    double Value
)

Restrict maximum value.

function GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

function ToString#

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

Get content of the node as string.

function FromString#

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

Set content of the node as string.

function IsValueCacheValid#

inline virtual bool IsValueCacheValid() const

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

function GetAccessMode#

inline virtual EAccessMode GetAccessMode() const

Get the access mode of the node.