All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
GenApi::ICommand Struct Referenceabstract

#include <GenApi/ICommand.h>

Inheritance diagram for GenApi::ICommand:
Inheritance graph
[legend]

Public Member Functions

virtual void Execute (bool Verify=true)=0
 Execute the command. More...
 
virtual void operator() ()=0
 Execute the command.
 
virtual bool IsDone (bool Verify=true)=0
 Query whether the command is executed. More...
 
virtual INodeGetNode ()
 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. More...
 
virtual void FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0
 Set content of the node as string. More...
 
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.
 

Detailed Description

Interface for command like properties

Member Function Documentation

virtual void GenApi::ICommand::Execute ( bool  Verify = true)
pure virtual

Execute the command.

Parameters
VerifyEnables AccessMode and Range verification (default = true)
virtual void GenApi::IValue::FromString ( const GenICam::gcstring ValueStr,
bool  Verify = true 
)
pure virtualinherited

Set content of the node as string.

Parameters
ValueStrThe value to set
VerifyEnables AccessMode and Range verification (default = true)
virtual bool GenApi::ICommand::IsDone ( bool  Verify = true)
pure virtual

Query whether the command is executed.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
Returns
True if the Execute command has finished; false otherwise
virtual GenICam::gcstring GenApi::IValue::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtualinherited

Get content of the node as string.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read

The documentation for this struct was generated from the following file:

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)