Skip to content

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

Inherited by Pylon::IFloatEx

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 EIncMode GetIncMode()
Get increment mode.
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 the physical unit name.
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.
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.

Additional inherited members#

Public Functions inherited from GenApi::IBase

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

Public Functions Documentation#

SetValue#

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

Set node value.

Parameters:

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

Reimplemented by: Pylon::CFloatParameter::SetValue

operator=#

virtual IFloat & operator=(
    double Value
) 

Set node value.

Reimplemented by: Pylon::CFloatParameter::operator=

GetValue#

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

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

operator()#

virtual double operator()() 

Get node value.

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

operator*#

virtual double operator*() 

Get node value.

Reimplemented by: Pylon::CFloatParameter::operator*

GetMin#

virtual double GetMin() 

Get minimum value allowed.

Reimplemented by: Pylon::CFloatParameter::GetMin

GetMax#

virtual double GetMax() 

Get maximum value allowed.

Reimplemented by: Pylon::CFloatParameter::GetMax

HasInc#

virtual bool HasInc() 

True if the float has a constant increment.

Reimplemented by: Pylon::CFloatParameter::HasInc

GetIncMode#

virtual EIncMode GetIncMode() 

Get increment mode.

Reimplemented by: Pylon::CFloatParameter::GetIncMode

GetInc#

virtual double GetInc() 

Get the constant increment if there is any.

Reimplemented by: Pylon::CFloatParameter::GetInc

GetListOfValidValues#

virtual double_autovector_t GetListOfValidValues(
    bool bounded =true
) 

Get list of valid value.

Reimplemented by: Pylon::CFloatParameter::GetListOfValidValues

GetRepresentation#

virtual ERepresentation GetRepresentation() 

Get recommended representation.

Reimplemented by: Pylon::CFloatParameter::GetRepresentation

GetUnit#

virtual GenICam::gcstring GetUnit() const 

Get the physical unit name.

Reimplemented by: Pylon::CFloatParameter::GetUnit

GetDisplayNotation#

virtual EDisplayNotation GetDisplayNotation() const 

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

Reimplemented by: Pylon::CFloatParameter::GetDisplayNotation

GetDisplayPrecision#

virtual int64_t GetDisplayPrecision() const 

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

Reimplemented by: Pylon::CFloatParameter::GetDisplayPrecision

ImposeMin#

virtual void ImposeMin(
    double Value
) 

Restrict minimum value.

Reimplemented by: Pylon::CFloatParameter::ImposeMin

ImposeMax#

virtual void ImposeMax(
    double Value
) 

Restrict maximum value.

Reimplemented by: Pylon::CFloatParameter::ImposeMax

GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

Reimplemented by: Pylon::CArrayParameter::GetNode

ToString#

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

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

FromString#

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

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

IsValueCacheValid#

virtual bool IsValueCacheValid() const 

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

Reimplemented by: Pylon::CArrayParameter::IsValueCacheValid

GetAccessMode#

virtual EAccessMode GetAccessMode() const 

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode


Updated on 5 July 2022 at 15:30:01