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)
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 mode.
virtual int64_t GetInc()
Get increment.
virtual int64_autovector_t GetListOfValidValues(bool bounded =true)
Get list of valid value.
virtual ERepresentation GetRepresentation()
Get recommended representation.
virtual GenICam::gcstring GetUnit()
Get the physical unit name.
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.

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(
    int64_t Value,
    bool Verify =true
) 

Set node value.

Parameters:

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

Reimplemented by: Pylon::CIntegerParameter::SetValue

operator=#

virtual IInteger & operator=(
    int64_t Value
) 

Set node value.

Reimplemented by: Pylon::CIntegerParameter::operator=

GetValue#

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

operator()#

virtual int64_t operator()() 

Get node value.

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

operator*#

virtual int64_t operator*() 

Get node value.

Reimplemented by: Pylon::CIntegerParameter::operator*

GetMin#

virtual int64_t GetMin() 

Get minimum value allowed.

Reimplemented by: Pylon::CIntegerParameter::GetMin

GetMax#

virtual int64_t GetMax() 

Get maximum value allowed.

Reimplemented by: Pylon::CIntegerParameter::GetMax

GetIncMode#

virtual EIncMode GetIncMode() 

Get increment mode.

Reimplemented by: Pylon::CIntegerParameter::GetIncMode

GetInc#

virtual int64_t GetInc() 

Get increment.

Reimplemented by: Pylon::CIntegerParameter::GetInc

GetListOfValidValues#

virtual int64_autovector_t GetListOfValidValues(
    bool bounded =true
) 

Get list of valid value.

Reimplemented by: Pylon::CIntegerParameter::GetListOfValidValues

GetRepresentation#

virtual ERepresentation GetRepresentation() 

Get recommended representation.

Reimplemented by: Pylon::CIntegerParameter::GetRepresentation

GetUnit#

virtual GenICam::gcstring GetUnit() 

Get the physical unit name.

Reimplemented by: Pylon::CIntegerParameter::GetUnit

ImposeMin#

virtual void ImposeMin(
    int64_t Value
) 

Restrict minimum value.

Reimplemented by: Pylon::CIntegerParameter::ImposeMin

ImposeMax#

virtual void ImposeMax(
    int64_t Value
) 

Restrict maximum value.

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