GenApi::IString#

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

Interface for string properties.

#include <GenApi/IString.h>

Inherits from GenApi::IValue, GenApi::IBase

Public Functions#

	Name
virtual void	SetValue(const GenICam::gcstring & Value, bool Verify =true) =0 Set node value.
virtual IString &	operator=(const GenICam::gcstring & Value) =0 Set node value.
virtual GenICam::gcstring	GetValue(bool Verify =false, bool IgnoreCache =false) =0 Get node value.
virtual GenICam::gcstring	operator())() =0 Get node value.
virtual GenICam::gcstring	operator*() =0 Get node value.
virtual int64_t	GetMaxLength() =0 Retrieves the maximum length of the string in bytes.
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(
    const GenICam::gcstring & 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::CStringParameter::SetValue

function operator=#

virtual IString & operator=(
    const GenICam::gcstring & Value
) =0

Set node value.

Reimplemented by: Pylon::CStringParameter::operator=

function GetValue#

virtual GenICam::gcstring 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::CStringParameter::GetValue

function operator()#

virtual GenICam::gcstring operator()() =0

Get node value.

Reimplemented by: Pylon::CStringParameter::operator())

function operator*#

virtual GenICam::gcstring operator*() =0

Get node value.

Reimplemented by: Pylon::CStringParameter::operator*

function GetMaxLength#

virtual int64_t GetMaxLength() =0

Retrieves the maximum length of the string in bytes.

Reimplemented by: Pylon::CStringParameter::GetMaxLength

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