Skip to content

GenApi::CCommandRefT#

More…

Inherits from GenApi::CValueRefT< T >

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.

Detailed Description#

template <class T >
class GenApi::CCommandRefT;

Public Functions Documentation#

Execute#

inline virtual void Execute(
    bool Verify =true
)

Execute the command.

operator()#

inline virtual void operator()()

Execute the command.

IsDone#

inline virtual bool IsDone(
    bool Verify =true
)

Query whether the command is executed.

GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

ToString#

inline virtual GenICam::gcstring ToString(
    bool Verify =false,
    bool IgnoreCache =false
)

Get content of the node as string.

FromString#

inline virtual void FromString(
    const GenICam::gcstring & ValueStr,
    bool Verify =true
)

Set content of the node as string.

IsValueCacheValid#

inline virtual bool IsValueCacheValid() const

Checks if the value comes from cache or is requested from another node.

GetAccessMode#

inline virtual EAccessMode GetAccessMode() const

Get the access mode of the node.


Updated on 5 July 2022 at 15:30:00