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

Interface for string properties. More...

#include <GenApi/IString.h>

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

Public Member Functions

virtual void SetValue (const GenICam::gcstring &Value, bool Verify=true)=0
 Set node value. More...
 
virtual IStringoperator= (const GenICam::gcstring &Value)=0
 Set node value.
 
virtual GenICam::gcstring GetValue (bool Verify=false, bool IgnoreCache=false)=0
 Get node value. More...
 
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 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 string properties.

Member Function Documentation

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 GenICam::gcstring GenApi::IString::GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Get node value.

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
virtual void GenApi::IString::SetValue ( const GenICam::gcstring Value,
bool  Verify = true 
)
pure virtual

Set node value.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)
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)