GenApi::IFloat#

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

Interface for float properties.

#include <GenApi/IFloat.h>

Inherits from GenApi::IValue, GenApi::IBase

Public Functions#

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

Public Functions Documentation#

function SetValue#

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

Set node value.

Parameters:

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

Reimplemented by: Pylon::CFloatParameter::SetValue

function operator=#

virtual IFloat & operator=(
    double Value
) =0

Set node value.

Reimplemented by: Pylon::CFloatParameter::operator=

function GetValue#

virtual double 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

Reimplemented by: Pylon::CFloatParameter::GetValue

function operator()#

virtual double operator()() =0

Get node value.

Reimplemented by: Pylon::CFloatParameter::operator())

function operator*#

virtual double operator*() =0

Get node value.

Reimplemented by: Pylon::CFloatParameter::operator*

function GetMin#

virtual double GetMin() =0

Get minimum value allowed.

Reimplemented by: Pylon::CFloatParameter::GetMin

function GetMax#

virtual double GetMax() =0

Get maximum value allowed.

Reimplemented by: Pylon::CFloatParameter::GetMax

function HasInc#

virtual bool HasInc() =0

True if the float has a constant increment.

Reimplemented by: Pylon::CFloatParameter::HasInc

function GetIncMode#

virtual EIncMode GetIncMode() =0

Get increment mode.

Reimplemented by: Pylon::CFloatParameter::GetIncMode

function GetInc#

virtual double GetInc() =0

Get the constant increment if there is any.

Reimplemented by: Pylon::CFloatParameter::GetInc

function GetListOfValidValues#

virtual double_autovector_t GetListOfValidValues(
    bool bounded =true
) =0

Get list of valid value.

Reimplemented by: Pylon::CFloatParameter::GetListOfValidValues

function GetRepresentation#

virtual ERepresentation GetRepresentation() =0

Get recommended representation.

Reimplemented by: Pylon::CFloatParameter::GetRepresentation

function GetUnit#

virtual GenICam::gcstring GetUnit() const =0

Get the physical unit name.

Reimplemented by: Pylon::CFloatParameter::GetUnit

function GetDisplayNotation#

virtual EDisplayNotation GetDisplayNotation() const =0

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

Reimplemented by: Pylon::CFloatParameter::GetDisplayNotation

function GetDisplayPrecision#

virtual int64_t GetDisplayPrecision() const =0

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

Reimplemented by: Pylon::CFloatParameter::GetDisplayPrecision

function ImposeMin#

virtual void ImposeMin(
    double Value
) =0

Restrict minimum value.

Reimplemented by: Pylon::CFloatParameter::ImposeMin

function ImposeMax#

virtual void ImposeMax(
    double Value
) =0

Restrict maximum value.

Reimplemented by: Pylon::CFloatParameter::ImposeMax

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