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

Interface for float properties. More...

#include <GenApi/IFloat.h>

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

Public Member Functions

virtual void SetValue (double Value, bool Verify=true)=0
 Set node value. More...
 
virtual IFloatoperator= (double Value)=0
 Set node value.
 
virtual double GetValue (bool Verify=false, bool IgnoreCache=false)=0
 Get node value. More...
 
virtual double operator() ()=0
 Get node value.
 
virtual double operator* ()=0
 Get node value.
 
virtual double GetMin ()=0
 Get minimum value allowed.
 
virtual double GetMax ()=0
 Get maximum value allowed.
 
virtual bool HasInc ()=0
 True if the float has a constant increment.
 
virtual EIncMode GetIncMode ()=0
 Get increment mode.
 
virtual double GetInc ()=0
 Get the constant increment if there is any.
 
virtual double_autovector_t GetListOfValidValues (bool bounded=true)=0
 Get list of valid value.
 
virtual ERepresentation GetRepresentation ()=0
 Get recommended representation.
 
virtual GenICam::gcstring GetUnit () const =0
 Get the physical unit name.
 
virtual EDisplayNotation GetDisplayNotation () const =0
 Get the way the float should be converted to a string.
 
virtual int64_t GetDisplayPrecision () const =0
 Get the precision to be used when converting the float to a string.
 
virtual void ImposeMin (double Value)=0
 Restrict minimum value.
 
virtual void ImposeMax (double Value)=0
 Restrict maximum value.
 
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 float 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 double GenApi::IFloat::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::IFloat::SetValue ( double  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)