![]() |
![]() |
CFloatParameter class used to simplify access to GenApi parameters. More...
#include <pylon/FloatParameter.h>
Public Member Functions | |
CFloatParameter () | |
Creates an empty CFloatParameter object. More... | |
CFloatParameter (GenApi::INode *pNode) | |
Creates a CFloatParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode(). More... | |
CFloatParameter (GenApi::IFloat *pFloat) | |
Creates a CFloatParameter object and attaches it to a node of a matching type. More... | |
CFloatParameter (GenApi::INodeMap *pNodeMap, const char *pName) | |
Creates a CFloatParameter object and attaches it to a node retrieved from the provided node map. More... | |
CFloatParameter (GenApi::INodeMap &nodeMap, const char *pName) | |
Creates a CFloatParameter object and attaches it to a node retrieved from the provided node map. More... | |
CFloatParameter (const CFloatParameter &rhs) | |
Copies a CFloatParameter object. More... | |
virtual | ~CFloatParameter () |
Destroys the CFloatParameter object. More... | |
virtual bool | Attach (GenApi::INodeMap *pNodeMap, const char *pName) |
Attaches a node retrieved from the provided node map. More... | |
virtual bool | Attach (GenApi::INodeMap &nodeMap, const char *pName) |
Attaches a node retrieved from the provided node map. More... | |
virtual bool | Attach (GenApi::INode *pNode) |
Attaches a node, typically retrieved for a nodemap calling GetNode(). More... | |
virtual bool | Attach (GenApi::IFloat *pFloat) |
Assigns a node of the same type to the parameter object. More... | |
CFloatParameter & | operator= (const CFloatParameter &rhs) |
Assigns a CFloatParameter object. More... | |
virtual bool | Equals (const CFloatParameter &rhs) const |
Returns true if the same nodes are attached or both parameters are empty. More... | |
virtual bool | Equals (const GenApi::INode *pNode) const |
Returns true if the attached node pointer is equal. More... | |
virtual bool | Equals (const GenApi::IFloat *pFloat) const |
Returns true if the attached node pointer is equal. More... | |
virtual void | Release () |
Releases the attached node. More... | |
virtual bool | IsValid () const |
Indicates whether a node is attached. More... | |
virtual void | SetValue (double value, bool verify=true) |
Set node value. More... | |
virtual GenApi::IFloat & | operator= (double value) |
Set node value. | |
virtual double | GetValue (bool verify=false, bool ignoreCache=false) |
Get node value. More... | |
virtual double | operator() () |
Get node value. | |
virtual double | operator* () |
Get node value. | |
virtual double | GetMin () |
Get minimum value allowed. | |
virtual double | GetMax () |
Get maximum value allowed. | |
virtual bool | HasInc () |
True if the float has a constant increment. | |
virtual GenApi::EIncMode | GetIncMode () |
Get increment mode. | |
virtual double | GetInc () |
Get the constant increment if there is any. | |
virtual GenApi::double_autovector_t | GetListOfValidValues (bool bounded=true) |
Get list of valid value. | |
virtual GenApi::ERepresentation | GetRepresentation () |
Get recommended representation. | |
virtual GenICam::gcstring | GetUnit () const |
Get the physical unit name. | |
virtual GenApi::EDisplayNotation | GetDisplayNotation () const |
Get the way the float should be converted to a string. | |
virtual int64_t | GetDisplayPrecision () const |
Get the precision to be used when converting the float to a string. | |
virtual void | ImposeMin (double value) |
Restrict minimum value. | |
virtual void | ImposeMax (double value) |
Restrict maximum value. | |
virtual bool | TrySetValue (double value) |
Sets the value of the parameter if the parameter is writable. More... | |
virtual double | GetValueOrDefault (double defaultValue) |
Gets the value of the parameter if the parameter is readable. More... | |
virtual bool | TrySetValue (double value, EFloatValueCorrection correction) |
Sets the value of the parameter if the parameter is writable and readable. More... | |
virtual void | SetValue (double value, EFloatValueCorrection correction) |
Sets the value of the parameter. More... | |
virtual double | GetValuePercentOfRange () |
Gets the value of the parameter in percent of its value range (from minimum to maximum). More... | |
virtual void | SetValuePercentOfRange (double percentOfRange) |
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) |
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 () |
Sets the parameter value to the maximum possible value. More... | |
virtual void | SetToMinimum () |
Sets the parameter value to the minimum possible value. More... | |
virtual bool | TrySetToMaximum () |
Sets the parameter value to the maximum possible value if the parameter is readable and writable. More... | |
virtual bool | TrySetToMinimum () |
Sets the parameter value to the minimum possible value if the parameter is readable and writable. More... | |
virtual void | GetAlternativeIntegerRepresentation (CIntegerParameter ¶meter) |
Gets the alternative integer representation of the float parameter, if available. More... | |
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 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... | |
virtual bool | Attach (GenApi::IValue *pValue) |
Assigns a node of the same type to the parameter object. More... | |
virtual bool | Equals (const CParameter &rhs) const |
Returns true if the same nodes are attached or both parameters are empty. More... | |
virtual bool | Equals (const GenApi::IValue *pValue) const |
Returns true if the attached node pointer is equal. More... | |
virtual GenApi::EAccessMode | GetAccessMode () const |
Get the access mode of the node. | |
virtual GenApi::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. More... | |
virtual void | FromString (const GenICam::gcstring &valueStr, bool verify=true) |
Set content of the node as string. More... | |
virtual bool | IsValueCacheValid () const |
Checks if the value comes from cache or is requested from another node. | |
virtual bool | IsReadable () const |
Indicates whether the parameter is readable. More... | |
virtual bool | IsWritable () const |
Indicates whether the parameter is writable. More... | |
virtual String_t | GetInfo (EParameterInfo info) |
Gets the parameter information. More... | |
virtual String_t | GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo) |
Gets the parameter information if the parameter is attached to a node. More... | |
virtual String_t | ToStringOrDefault (const String_t &defaultValue) |
Gets the parameter value as string if the parameter is readable. More... | |
CFloatParameter class used to simplify access to GenApi parameters.
Pylon::CFloatParameter::CFloatParameter | ( | ) |
Creates an empty CFloatParameter object.
|
explicit |
Creates a CFloatParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode().
[in] | pNode | The node to attach. |
pNode
has been destroyed. In this case, call Release() or attach a new node.
|
explicit |
Creates a CFloatParameter object and attaches it to a node of a matching type.
[in] | pFloat | The node to attach. |
pFloat
has been destroyed. In this case, call Release() or attach a new node. Pylon::CFloatParameter::CFloatParameter | ( | GenApi::INodeMap * | pNodeMap, |
const char * | pName | ||
) |
Creates a CFloatParameter object and attaches it to a node retrieved from the provided node map.
[in] | pNodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
pNodeMap
or name
is NULL, the parameter will be empty, see IsValid(). Pylon::CFloatParameter::CFloatParameter | ( | GenApi::INodeMap & | nodeMap, |
const char * | pName | ||
) |
Creates a CFloatParameter object and attaches it to a node retrieved from the provided node map.
[in] | nodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
name
is NULL, the parameter will be empty, see IsValid(). Pylon::CFloatParameter::CFloatParameter | ( | const CFloatParameter & | rhs | ) |
Copies a CFloatParameter object.
[in] | rhs | The object to copy. |
|
virtual |
Destroys the CFloatParameter object.
Does not access the attached node.
|
virtualinherited |
Assigns a node of the same type to the parameter object.
[in] | pValue | The node to assign. |
|
virtual |
Attaches a node retrieved from the provided node map.
[in] | pNodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
pNodeMap
or name
is NULL, the parameter will be empty, see IsValid(). Reimplemented from Pylon::CParameter.
|
virtual |
Attaches a node retrieved from the provided node map.
[in] | nodeMap | The node map. The source of the parameter. |
[in] | pName | The name of the parameter to attach. |
name
is NULL the parameter will be empty, see IsValid(). Reimplemented from Pylon::CParameter.
|
virtual |
Attaches a node, typically retrieved for a nodemap calling GetNode().
[in] | pNode | The node to assign. |
pNode
has been destroyed. In this case, call Release() or attach a new node. Reimplemented from Pylon::CParameter.
|
virtual |
Assigns a node of the same type to the parameter object.
[in] | pFloat | The node to assign. |
|
virtualinherited |
Returns true if the same nodes are attached or both parameters are empty.
[in] | rhs | The object to compare to. |
|
virtualinherited |
Returns true if the attached node pointer is equal.
[in] | pValue | The node to compare to. |
|
virtual |
Returns true if the same nodes are attached or both parameters are empty.
[in] | rhs | The object to compare to. |
|
virtual |
Returns true if the attached node pointer is equal.
[in] | pNode | The node to compare to. |
Reimplemented from Pylon::CParameter.
|
virtual |
Returns true if the attached node pointer is equal.
[in] | pFloat | The node to compare to. |
|
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.
|
virtualinherited |
Set content of the node as string.
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implements GenApi::IValue.
|
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. |
Implements Pylon::IFloatEx.
|
pure virtualinherited |
Gets the parameter information.
[in] | info | The type information to return. |
Implemented in Pylon::CParameter.
|
virtualinherited |
Gets the parameter information.
[in] | info | The type information to return. |
Implements Pylon::IValueEx.
|
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.
|
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. |
Implements Pylon::IValueEx.
|
virtual |
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) |
Implements GenApi::IFloat.
|
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. |
Implements Pylon::IFloatEx.
|
virtual |
Gets the value of the parameter in percent of its value range (from minimum to maximum).
Implements Pylon::IFloatEx.
|
pure virtualinherited |
Indicates whether the parameter is readable.
Implemented in Pylon::CParameter.
|
virtualinherited |
Indicates whether the parameter is readable.
Implements Pylon::IValueEx.
|
virtual |
Indicates whether a node is attached.
Reimplemented from Pylon::CParameter.
|
pure virtualinherited |
Indicates whether the parameter is writable.
Implemented in Pylon::CParameter.
|
virtualinherited |
Indicates whether the parameter is writable.
Implements Pylon::IValueEx.
CFloatParameter& Pylon::CFloatParameter::operator= | ( | const CFloatParameter & | rhs | ) |
Assigns a CFloatParameter object.
[in] | rhs | The object to assign. |
|
virtual |
Releases the attached node.
Reimplemented from Pylon::CParameter.
|
virtual |
Sets the parameter value to the maximum possible value.
Implements Pylon::IFloatEx.
|
virtual |
Sets the parameter value to the minimum possible value.
Implements Pylon::IFloatEx.
|
virtual |
Set node value.
Value | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implements GenApi::IFloat.
|
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. Implements Pylon::IFloatEx.
|
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. |
Implements Pylon::IFloatEx.
|
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.
|
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) |
Implements GenApi::IValue.
|
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.
|
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. |
Implements Pylon::IValueEx.
|
virtual |
Sets the parameter value to the maximum possible value if the parameter is readable and writable.
Implements Pylon::IFloatEx.
|
virtual |
Sets the parameter value to the minimum possible value if the parameter is readable and writable.
Implements Pylon::IFloatEx.
|
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.
Implements Pylon::IFloatEx.
|
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. Implements Pylon::IFloatEx.
|
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. |
Implements Pylon::IFloatEx.