Skip to content
STAGING SERVER
DEVELOPMENT SERVER

GenApi::ICommand#

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

More…

#include <GenApi/ICommand.h>

Inherits from GenApi::IValue, GenApi::IBase

Inherited by Pylon::ICommandEx

Public Functions#

Name
virtual void Execute(bool Verify =true) =0
Execute the command.
virtual void operator())() =0
Execute the command.
virtual bool IsDone(bool Verify =true) =0
Query whether the command is executed.
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.

Detailed Description#

struct GenApi::ICommand;

Interface for command like properties

Public Functions Documentation#

function Execute#

virtual void Execute(
    bool Verify =true
) =0

Execute the command.

Parameters:

  • Verify Enables AccessMode and Range verification (default = true)

Reimplemented by: Pylon::CCommandParameter::Execute

function operator()#

virtual void operator()() =0

Execute the command.

Reimplemented by: Pylon::CCommandParameter::operator())

function IsDone#

virtual bool IsDone(
    bool Verify =true
) =0

Query whether the command is executed.

Parameters:

  • Verify Enables Range verification (default = false). The AccessMode is always checked

Return: True if the Execute command has finished; false otherwise

Reimplemented by: Pylon::CCommandParameter::IsDone

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