Skip to content

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)
Execute the command.
virtual void operator()()
Execute the command.
virtual bool IsDone(bool Verify =true)
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)
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.

Detailed Description#

struct GenApi::ICommand;

Interface for command like properties

Public Functions Documentation#

Execute#

virtual void Execute(
    bool Verify =true
) 

Execute the command.

Parameters:

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

Reimplemented by: Pylon::CCommandParameter::Execute

operator()#

virtual void operator()() 

Execute the command.

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

IsDone#

virtual bool IsDone(
    bool Verify =true
) 

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

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