![]() |
![]() |
Extends the GenApi::IFloat interface with convenience methods. More...
#include <pylon/FloatParameter.h>
Public Member Functions | |
virtual bool | TrySetValue (double value)=0 |
Sets the value of the parameter if the parameter is writable. More... | |
virtual double | GetValueOrDefault (double defaultValue)=0 |
Gets the value of the parameter if the parameter is readable. More... | |
virtual bool | TrySetValue (double value, EFloatValueCorrection correction)=0 |
Sets the value of the parameter if the parameter is writable and readable. More... | |
virtual void | SetValue (double value, EFloatValueCorrection correction)=0 |
Sets the value of the parameter. More... | |
virtual double | GetValuePercentOfRange ()=0 |
Gets the value of the parameter in percent of its value range (from minimum to maximum). More... | |
virtual void | SetValuePercentOfRange (double percentOfRange)=0 |
Sets the value of the parameter to a value within its range, using this formula (simplified): ((max - min) * (percentOfRange / 100.0)) + min. More... | |
virtual bool | TrySetValuePercentOfRange (double percentOfRange)=0 |
If the parameter is writable and readable, sets the value of the parameter to a value within its range, using this formula (simplified): ((max - min) * (percentOfRange / 100.0)) + min. More... | |
virtual void | SetToMaximum ()=0 |
Sets the parameter value to the maximum possible value. More... | |
virtual void | SetToMinimum ()=0 |
Sets the parameter value to the minimum possible value. More... | |
virtual bool | TrySetToMaximum ()=0 |
Sets the parameter value to the maximum possible value if the parameter is readable and writable. More... | |
virtual bool | TrySetToMinimum ()=0 |
Sets the parameter value to the minimum possible value if the parameter is readable and writable. More... | |
virtual void | GetAlternativeIntegerRepresentation (CIntegerParameter ¶meter)=0 |
Gets the alternative integer representation of the float parameter, if available. More... | |
virtual void | SetValue (double Value, bool Verify=true)=0 |
Set node value. More... | |
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 INode * | GetNode () |
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. | |
virtual bool | IsReadable () const =0 |
Indicates whether the parameter is readable. More... | |
virtual bool | IsWritable () const =0 |
Indicates whether the parameter is writable. More... | |
virtual bool | IsValid () const =0 |
Indicates whether a node is attached. More... | |
virtual String_t | GetInfo (EParameterInfo info)=0 |
Gets the parameter information. More... | |
virtual String_t | GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo)=0 |
Gets the parameter information if the parameter is attached to a node. More... | |
virtual String_t | ToStringOrDefault (const String_t &defaultValue)=0 |
Gets the parameter value as string if the parameter is readable. More... | |
Extends the GenApi::IFloat interface with convenience methods.
|
pure virtualinherited |
Set content of the node as string.
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CParameter.
|
pure virtual |
Gets the alternative integer representation of the float parameter, if available.
The alternative integer representation is typically used if a parameter is represented as a float value in the node map, but as an integer register in the camera device.
[out] | parameter | The integer representation returned. The returned value will be empty if no alternative representation is available. |
Implemented in Pylon::CFloatParameter.
|
pure virtualinherited |
Gets the parameter information.
[in] | info | The type information to return. |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Gets the parameter information if the parameter is attached to a node.
See IsValid().
[in] | info | The type information to return. Otherwise returns the default information. This method is useful if you want to display parameter information and handle the case that some parameters are not available for a device. |
[in] | defaultInfo | The default information returned if the parameter is not attached to a node. |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Get node value.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Gets the value of the parameter if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Gets the value of the parameter in percent of its value range (from minimum to maximum).
Implemented in Pylon::CFloatParameter.
|
pure virtualinherited |
Indicates whether the parameter is readable.
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Indicates whether a node is attached.
Implemented in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
pure virtualinherited |
Indicates whether the parameter is writable.
Implemented in Pylon::CParameter.
|
pure virtual |
Sets the parameter value to the maximum possible value.
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Sets the parameter value to the minimum possible value.
Implemented in Pylon::CFloatParameter.
|
pure virtualinherited |
Set node value.
Value | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Sets the value of the parameter.
The value is automatically corrected if needed.
[in] | value | The value to set. |
[in] | correction | The correction method. |
correction
equals FloatValueCorrection_None. Implemented in Pylon::CFloatParameter.
|
pure virtual |
Sets the value of the parameter to a value within its range, using this formula (simplified): ((max - min) * (percentOfRange / 100.0)) + min.
[in] | percentOfRange | The percentage of the range to be used in the calculation. |
Implemented in Pylon::CFloatParameter.
|
pure virtualinherited |
Get content of the node as string.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Gets the parameter value as string if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
Implemented in Pylon::CParameter.
|
pure virtual |
Sets the parameter value to the maximum possible value if the parameter is readable and writable.
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Sets the parameter value to the minimum possible value if the parameter is readable and writable.
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Sets the value of the parameter if the parameter is writable.
The value must be in the valid range and the increment must be correct.
[in] | value | The value to set. |
If the float parameter has an increment, the increment is automatically corrected.
Implemented in Pylon::CFloatParameter.
|
pure virtual |
Sets the value of the parameter if the parameter is writable and readable.
The value is automatically corrected if needed.
[in] | value | The value to set. |
[in] | correction | The correction method. |
correction
equals FloatValueCorrection_None. Implemented in Pylon::CFloatParameter.
|
pure virtual |
If the parameter is writable and readable, sets the value of the parameter to a value within its range, using this formula (simplified): ((max - min) * (percentOfRange / 100.0)) + min.
[in] | percentOfRange | The percentage of the range used in the calculation. Valid values are in the range of 0 to 100. |
Implemented in Pylon::CFloatParameter.