Skip to content

GenApi::IBoolean#

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

Interface for Boolean properties.

#include <GenApi/IBoolean.h>

Inherits from GenApi::IValue, GenApi::IBase

Inherited by Pylon::IBooleanEx

Public Functions#

Name
virtual void SetValue(bool Value, bool Verify =true)
Set node value.
virtual void operator=(bool Value)
Set node value.
virtual bool GetValue(bool Verify =false, bool IgnoreCache =false) const
Get node value.
virtual bool operator()() const
Get node 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(
    bool Value,
    bool Verify =true
) 

Set node value.

Parameters:

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

Reimplemented by: Pylon::CBooleanParameter::SetValue

operator=#

inline virtual void operator=(
    bool Value
)

Set node value.

Reimplemented by: Pylon::CBooleanParameter::operator=

GetValue#

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

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::CBooleanParameter::GetValue

operator()#

inline virtual bool operator()() const

Get node value.

Reimplemented by: Pylon::CBooleanParameter::operator()

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