Skip to content

GenApi::IInteger#

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

Interface for integer properties.

#include <GenApi/IInteger.h>

Inherits from GenApi::IValue, GenApi::IBase

Inherited by Pylon::IIntegerEx

Public Functions#

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

function operator=#

virtual IInteger & operator=(
    int64_t Value
) =0

Set node value.

Reimplemented by: Pylon::CIntegerParameter::operator=

function GetValue#

virtual int64_t 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::CIntegerParameter::GetValue

function operator()#

virtual int64_t operator()() =0

Get node value.

Reimplemented by: Pylon::CIntegerParameter::operator())

function operator*#

virtual int64_t operator*() =0

Get node value.

Reimplemented by: Pylon::CIntegerParameter::operator*

function GetMin#

virtual int64_t GetMin() =0

Get minimum value allowed.

Reimplemented by: Pylon::CIntegerParameter::GetMin

function GetMax#

virtual int64_t GetMax() =0

Get maximum value allowed.

Reimplemented by: Pylon::CIntegerParameter::GetMax

function GetIncMode#

virtual EIncMode GetIncMode() =0

Get increment mode.

Reimplemented by: Pylon::CIntegerParameter::GetIncMode

function GetInc#

virtual int64_t GetInc() =0

Get increment.

Reimplemented by: Pylon::CIntegerParameter::GetInc

function GetListOfValidValues#

virtual int64_autovector_t GetListOfValidValues(
    bool bounded =true
) =0

Get list of valid value.

Reimplemented by: Pylon::CIntegerParameter::GetListOfValidValues

function GetRepresentation#

virtual ERepresentation GetRepresentation() =0

Get recommended representation.

Reimplemented by: Pylon::CIntegerParameter::GetRepresentation

function GetUnit#

virtual GenICam::gcstring GetUnit() =0

Get the physical unit name.

Reimplemented by: Pylon::CIntegerParameter::GetUnit

function ImposeMin#

virtual void ImposeMin(
    int64_t Value
) =0

Restrict minimum value.

Reimplemented by: Pylon::CIntegerParameter::ImposeMin

function ImposeMax#

virtual void ImposeMax(
    int64_t Value
) =0

Restrict maximum value.

Reimplemented by: Pylon::CIntegerParameter::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