Pylon::CFloatParameter#

CFloatParameter class used to simplify access to GenApi parameters.

#include <pylon/FloatParameter.h>

Inherits from Pylon::IFloatEx, Pylon::CParameter, GenApi::IFloat, Pylon::IValueEx, GenApi::IValue, GenApi::IBase

Public Functions#

Additional inherited members#

Public Functions inherited from Pylon::CParameter

Public Functions inherited from GenApi::IBase

Public Functions Documentation#

function CFloatParameter#

CFloatParameter()

Creates an empty CFloatParameter object.

Error Safety:

Does not throw C++ exceptions.

function CFloatParameter#

explicit CFloatParameter(
    GenApi::INode * pNode
)

Creates a CFloatParameter object and attaches it to a node, typically retrieved for a nodemap calling GetNode().

Parameters:

• pNode The node to attach.

Postcondition:

• If the passed node does not match the parameter type, the parameter will be empty, see IsValid().
• If the passed node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
• The parameter object must not be used to access the node's functionality if the source of the attached pNode has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

Does not throw C++ exceptions.

function CFloatParameter#

explicit CFloatParameter(
    GenApi::IFloat * pFloat
)

Creates a CFloatParameter object and attaches it to a node of a matching type.

Parameters:

• pFloat The node to attach.

Postcondition: The parameter object must not be used to access the node's functionality if the source of the attached pFloat has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

Does not throw C++ exceptions.

function CFloatParameter#

CFloatParameter(
    GenApi::INodeMap * pNodeMap,
    const char * pName
)

Creates a CFloatParameter object and attaches it to a node retrieved from the provided node map.

Parameters:

• pNodeMap The node map. The source of the parameter.
• pName The name of the parameter to attach.

Postcondition:

• If pNodeMap or name is NULL, the parameter will be empty, see IsValid().
• If the node does not match the parameter type, the parameter will be empty, see IsValid().
• If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
• The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

The call to GenApi::INodeMap::GetNode can throw C++ exceptions.

function CFloatParameter#

CFloatParameter(
    GenApi::INodeMap & nodeMap,
    const char * pName
)

Creates a CFloatParameter object and attaches it to a node retrieved from the provided node map.

Parameters:

• nodeMap The node map. The source of the parameter.
• pName The name of the parameter to attach.

Postcondition:

• If name is NULL, the parameter will be empty, see IsValid().
• If the node does not match the parameter type, the parameter will be empty, see IsValid().
• If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
• The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

The call to GenApi::INodeMap::GetNode can throw C++ exceptions.

function CFloatParameter#

CFloatParameter(
    const CFloatParameter & rhs
)

Copies a CFloatParameter object.

Parameters:

• rhs The object to copy.

Error Safety:

Does not throw C++ exceptions.

function ~CFloatParameter#

virtual ~CFloatParameter()

Destroys the CFloatParameter object.

Error Safety:

Does not throw C++ exceptions.

Does not access the attached node.

function Attach#

virtual bool Attach(
    GenApi::INodeMap * pNodeMap,
    const char * pName
)

Attaches a node retrieved from the provided node map.

Parameters:

• pNodeMap The node map. The source of the parameter.
• pName The name of the parameter to attach.

Return: Returns true if the node has been attached.

Postcondition:

• If pNodeMap or name is NULL, the parameter will be empty, see IsValid().
• If the node does not match the parameter type, the parameter will be empty, see IsValid().
• If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
• The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

The call to GenApi::INodeMap::GetNode can throw C++ exceptions.

Reimplements: Pylon::CParameter::Attach

function Attach#

virtual bool Attach(
    GenApi::INodeMap & nodeMap,
    const char * pName
)

Attaches a node retrieved from the provided node map.

Parameters:

• nodeMap The node map. The source of the parameter.
• pName The name of the parameter to attach.

Return: Returns true if the node has been attached.

Postcondition:

• If name is NULL the parameter will be empty, see IsValid().
• If the node does not match the parameter type, the parameter will be empty, see IsValid().
• If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
• The parameter object must not be used to access the node's functionality if the provided node map has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

The call to GenApi::INodeMap::GetNode can throw C++ exceptions.

Reimplements: Pylon::CParameter::Attach

function Attach#

virtual bool Attach(
    GenApi::INode * pNode
)

Attaches a node, typically retrieved for a nodemap calling GetNode().

Parameters:

• pNode The node to assign.

Return: Returns true if the node has been attached.

Postcondition:

• If the node does not match the parameter type, the parameter will be empty, see IsValid().
• If the node does match the parameter type, it is attached and the parameter object can be used to access the node's functionality.
• The parameter object must not be used to access the node's functionality if the source of the attached pNode has been destroyed. In this case, call Release() or attach a new node.

Error Safety:

Does not throw C++ exceptions.

Reimplements: Pylon::CParameter::Attach

function Attach#

virtual bool Attach(
    GenApi::IFloat * pFloat
)

Assigns a node of the same type to the parameter object.

Parameters:

• pFloat The node to assign.

Return: Returns true if the node has been attached.

Error Safety:

Does not throw C++ exceptions.

function operator=#

CFloatParameter & operator=(
    const CFloatParameter & rhs
)

Assigns a CFloatParameter object.

Parameters:

• rhs The object to assign.

Error Safety:

Does not throw C++ exceptions.

function Equals#

virtual bool Equals(
    const CFloatParameter & rhs
) const

Returns true if the same nodes are attached or both parameters are empty.

Parameters:

• rhs The object to compare to.

Return: Returns true if the same nodes are attached or both parameters are empty.

Error Safety:

Does not throw C++ exceptions.

function Equals#

virtual bool Equals(
    const GenApi::INode * pNode
) const

Returns true if the attached node pointer is equal.

Parameters:

• pNode The node to compare to.

Return: Returns true if the attached node pointer is equal.

Error Safety:

Does not throw C++ exceptions.

Reimplements: Pylon::CParameter::Equals

function Equals#

virtual bool Equals(
    const GenApi::IFloat * pFloat
) const

Returns true if the attached node pointer is equal.

Parameters:

• pFloat The node to compare to.

Return: Returns true if the attached node pointer is equal.

Error Safety:

Does not throw C++ exceptions.

function Release#

virtual void Release()

Releases the attached node.

Error Safety:

Does not throw C++ exceptions.

Reimplements: Pylon::CParameter::Release

function IsValid#

virtual bool IsValid() const

Indicates whether a node is attached.

Return: Returns true if a node is attached.

Error Safety:

Does not throw C++ exceptions.

Reimplements: Pylon::CParameter::IsValid

function SetValue#

virtual void SetValue(
    double Value,
    bool Verify =true
)

Set node value.

Parameters:

• Value The value to set
• Verify Enables AccessMode and Range verification (default = true)

Reimplements: GenApi::IFloat::SetValue

function operator=#

virtual GenApi::IFloat & operator=(
    double Value
)

Set node value.

Reimplements: GenApi::IFloat::operator=

function GetValue#

virtual double GetValue(
    bool Verify =false,
    bool IgnoreCache =false
)

Get node value.

Parameters:

• Verify Enables Range verification (default = false). The AccessMode is always checked
• IgnoreCache If true the value is read ignoring any caches (default = false)

Return: The value read

Reimplements: GenApi::IFloat::GetValue

function operator()#

virtual double operator()()

Get node value.

Reimplements: GenApi::IFloat::operator())

function operator*#

virtual double operator*()

Get node value.

Reimplements: GenApi::IFloat::operator*

function GetMin#

virtual double GetMin()

Get minimum value allowed.

Reimplements: GenApi::IFloat::GetMin

function GetMax#

virtual double GetMax()

Get maximum value allowed.

Reimplements: GenApi::IFloat::GetMax

function HasInc#

virtual bool HasInc()

True if the float has a constant increment.

Reimplements: GenApi::IFloat::HasInc

function GetIncMode#

virtual GenApi::EIncMode GetIncMode()

Get increment mode.

Reimplements: GenApi::IFloat::GetIncMode

function GetInc#

virtual double GetInc()

Get the constant increment if there is any.

Reimplements: GenApi::IFloat::GetInc

function GetListOfValidValues#

virtual GenApi::double_autovector_t GetListOfValidValues(
    bool bounded =true
)

Get list of valid value.

Reimplements: GenApi::IFloat::GetListOfValidValues

function GetRepresentation#

virtual GenApi::ERepresentation GetRepresentation()

Get recommended representation.

Reimplements: GenApi::IFloat::GetRepresentation

function GetUnit#

virtual GenICam::gcstring GetUnit() const

Get the physical unit name.

Reimplements: GenApi::IFloat::GetUnit

function GetDisplayNotation#

virtual GenApi::EDisplayNotation GetDisplayNotation() const

Get the way the float should be converted to a string.

Reimplements: GenApi::IFloat::GetDisplayNotation

function GetDisplayPrecision#

virtual int64_t GetDisplayPrecision() const

Get the precision to be used when converting the float to a string.

Reimplements: GenApi::IFloat::GetDisplayPrecision

function ImposeMin#

virtual void ImposeMin(
    double Value
)

Restrict minimum value.

Reimplements: GenApi::IFloat::ImposeMin

function ImposeMax#

virtual void ImposeMax(
    double Value
)

Restrict maximum value.

Reimplements: GenApi::IFloat::ImposeMax

function TrySetValue#

virtual bool TrySetValue(
    double value
)

Sets the value of the parameter if the parameter is writable.

Parameters:

• value The value to set.

Return: Returns false if the parameter is not writable.

Precondition:

• The passed value must be >= GenApi::IFloat::GetMin().
• The passed value must be <= GenApi::IFloat::GetMax().

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if the preconditions are not met or if writing the value fails.

Reimplements: Pylon::IFloatEx::TrySetValue

The value must be in the valid range and the increment must be correct. If the float parameter has an increment, the increment is automatically corrected.

function GetValueOrDefault#

virtual double GetValueOrDefault(
    double defaultValue
)

Gets the value of the parameter if the parameter is readable.

Parameters:

• defaultValue The default value returned if the parameter is not readable.

Return: Returns the parameter value if the parameter is readable. Otherwise returns the default value.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exception if reading the value fails.

Reimplements: Pylon::IFloatEx::GetValueOrDefault

Otherwise returns the default value.

function TrySetValue#

virtual bool TrySetValue(
    double value,
    EFloatValueCorrection correction
)

Sets the value of the parameter if the parameter is writable and readable.

Parameters:

• value The value to set.
• correction The correction method.

Return: Returns false if the parameter is not readable or not writable.

Note Calls TrySetValue(GenApi::IFloatParameter, double) if correction equals FloatValueCorrection_None.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if writing the value fails.

Reimplements: Pylon::IFloatEx::TrySetValue

The value is automatically corrected if needed.

function SetValue#

virtual void SetValue(
    double value,
    EFloatValueCorrection correction
)

Sets the value of the parameter.

Parameters:

• value The value to set.
• correction The correction method.

Note Calls GenApi::IFloatParameter::SetValue(double) if correction equals FloatValueCorrection_None.

Precondition:

• The parameter must be writable.
• The parameter must be readable.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if the preconditions are not met or if writing the value fails.

Reimplements: Pylon::IFloatEx::SetValue

The value is automatically corrected if needed.

function GetValuePercentOfRange#

virtual double GetValuePercentOfRange()

Gets the value of the parameter in percent of its value range (from minimum to maximum).

Return: Returns the parameter value in percent of its value range. Returns 100 if minimum equals maximum.

Precondition: The parameter must be readable.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if writing the value fails.

Reimplements: Pylon::IFloatEx::GetValuePercentOfRange

function SetValuePercentOfRange#

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.

Parameters:

• percentOfRange The percentage of the range to be used in the calculation.

Precondition:

• The parameter must be writable.
• The parameter must be readable.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if writing the value fails.

Reimplements: Pylon::IFloatEx::SetValuePercentOfRange

function TrySetValuePercentOfRange#

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.

Parameters:

• percentOfRange The percentage of the range used in the calculation. Valid values are in the range of 0 to 100.

Return: Returns true if the value has been set.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if writing the value fails.

Reimplements: Pylon::IFloatEx::TrySetValuePercentOfRange

function SetToMaximum#

virtual void SetToMaximum()

Sets the parameter value to the maximum possible value.

Precondition:

• The parameter must be writable.
• The parameter must be readable.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if the parameter is not writable, not readable, or if reading or writing fails.

Reimplements: Pylon::IFloatEx::SetToMaximum

function SetToMinimum#

virtual void SetToMinimum()

Sets the parameter value to the minimum possible value.

Precondition:

• The parameter must be writable.
• The parameter must be readable.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if the parameter is not writable, not readable, or if reading or writing fails.

Reimplements: Pylon::IFloatEx::SetToMinimum

function TrySetToMaximum#

virtual bool TrySetToMaximum()

Sets the parameter value to the maximum possible value if the parameter is readable and writable.

Return: Returns true if the maximum value has been set.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if reading or writing fails.

Reimplements: Pylon::IFloatEx::TrySetToMaximum

function TrySetToMinimum#

virtual bool TrySetToMinimum()

Sets the parameter value to the minimum possible value if the parameter is readable and writable.

Return: Returns true if the minimum value has been set.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if reading or writing fails.

Reimplements: Pylon::IFloatEx::TrySetToMinimum

function GetAlternativeIntegerRepresentation#

virtual void GetAlternativeIntegerRepresentation(
    CIntegerParameter & parameter
)

Gets the alternative integer representation of the float parameter, if available.

Parameters:

• parameter The integer representation returned. The returned value will be empty if no alternative representation is available.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions.

Reimplements: Pylon::IFloatEx::GetAlternativeIntegerRepresentation

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.

function GetNode#

inline virtual INode * GetNode()

Get the INode interface of the node.

Reimplemented by: Pylon::CArrayParameter::GetNode

function ToString#

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

Get content of the node as string.

Parameters:

• Verify Enables Range verification (default = false). The AccessMode is always checked
• IgnoreCache If true the value is read ignoring any caches (default = false)

Return: The value read

Reimplemented by: Pylon::CArrayParameter::ToString

function FromString#

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

Set content of the node as string.

Parameters:

• ValueStr The value to set
• Verify Enables AccessMode and Range verification (default = true)

Reimplemented by: Pylon::CArrayParameter::FromString

function IsValueCacheValid#

virtual bool IsValueCacheValid() const =0

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

Reimplemented by: Pylon::CArrayParameter::IsValueCacheValid

function GetAccessMode#

virtual EAccessMode GetAccessMode() const =0

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode

function IsReadable#

virtual bool IsReadable() const =0

Indicates whether the parameter is readable.

Return: Returns true if the parameter is readable.

Error Safety:

Does not throw C++ exceptions.

Reimplemented by: Pylon::CArrayParameter::IsReadable

function IsWritable#

virtual bool IsWritable() const =0

Indicates whether the parameter is writable.

Return: Returns true if the parameter is writable.

Error Safety:

Does not throw C++ exceptions.

Reimplemented by: Pylon::CArrayParameter::IsWritable

function GetInfo#

virtual String_t GetInfo(
    EParameterInfo info
) =0

Gets the parameter information.

Parameters:

• info The type information to return.

Return: Returns the parameter information.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Throws an exception if no node is attached. Can throw exceptions if the retrieval of the information fails.

Reimplemented by: Pylon::CArrayParameter::GetInfo

function GetInfoOrDefault#

virtual String_t GetInfoOrDefault(
    EParameterInfo info,
    const String_t defaultInfo
) =0

Gets the parameter information if the parameter is attached to a node.

Parameters:

• 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.
• defaultInfo The default information returned if the parameter is not attached to a node.

Return: Returns the parameter information if the parameter is attached to a node. Otherwise returns the default information.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if the retrieval of the information fails.

Reimplemented by: Pylon::CArrayParameter::GetInfoOrDefault

See IsValid().

function ToStringOrDefault#

virtual String_t ToStringOrDefault(
    const String_t & defaultValue
) =0

Gets the parameter value as string if the parameter is readable.

Parameters:

• defaultValue The default value returned if the parameter is not readable.

Return: Returns the parameter value if the parameter is readable. Otherwise returns the default value.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if reading the value fails.

Reimplemented by: Pylon::CArrayParameter::ToStringOrDefault

Otherwise returns the default value.

function Attach#

virtual bool Attach(
    GenApi::IValue * pValue
)

Assigns a node of the same type to the parameter object.

Parameters:

• pValue The node to assign.

Return: Returns true if the node has been attached.

Error Safety:

Does not throw C++ exceptions.

function Equals#

virtual bool Equals(
    const CParameter & rhs
) const

Returns true if the same nodes are attached or both parameters are empty.

Parameters:

• rhs The object to compare to.

Return: Returns true if the same nodes are attached or both parameters are empty.

Error Safety:

Does not throw C++ exceptions.

function Equals#

virtual bool Equals(
    const GenApi::IValue * pValue
) const

Returns true if the attached node pointer is equal.

Parameters:

• pValue The node to compare to.

Return: Returns true if the attached node pointer is equal.

Error Safety:

Does not throw C++ exceptions.

function GetAccessMode#

virtual GenApi::EAccessMode GetAccessMode() const

Get the access mode of the node.

Reimplements: GenApi::IBase::GetAccessMode

function GetNode#

virtual GenApi::INode * GetNode()

Get the INode interface of the node.

Reimplements: GenApi::IBoolean::GetNode

function ToString#

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

Get content of the node as string.

Parameters:

• Verify Enables Range verification (default = false). The AccessMode is always checked
• IgnoreCache If true the value is read ignoring any caches (default = false)

Return: The value read

Reimplements: GenApi::IBoolean::ToString

function FromString#

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

Set content of the node as string.

Parameters:

• ValueStr The value to set
• Verify Enables AccessMode and Range verification (default = true)

Reimplements: GenApi::IBoolean::FromString

function IsValueCacheValid#

virtual bool IsValueCacheValid() const

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

Reimplements: GenApi::IBoolean::IsValueCacheValid

function IsReadable#

virtual bool IsReadable() const

Indicates whether the parameter is readable.

Return: Returns true if the parameter is readable.

Error Safety:

Does not throw C++ exceptions.

Reimplements: Pylon::CArrayParameter::IsReadable

function IsWritable#

virtual bool IsWritable() const

Indicates whether the parameter is writable.

Return: Returns true if the parameter is writable.

Error Safety:

Does not throw C++ exceptions.

Reimplements: Pylon::CArrayParameter::IsWritable

function GetInfo#

virtual String_t GetInfo(
    EParameterInfo info
)

Gets the parameter information.

Parameters:

• info The type information to return.

Return: Returns the parameter information.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Throws an exception if no node is attached. Can throw exceptions if the retrieval of the information fails.

Reimplements: Pylon::CArrayParameter::GetInfo

function GetInfoOrDefault#

virtual String_t GetInfoOrDefault(
    EParameterInfo info,
    const String_t defaultInfo
)

Gets the parameter information if the parameter is attached to a node.

Parameters:

• 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.
• defaultInfo The default information returned if the parameter is not attached to a node.

Return: Returns the parameter information if the parameter is attached to a node. Otherwise returns the default information.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if the retrieval of the information fails.

Reimplements: Pylon::CArrayParameter::GetInfoOrDefault

See IsValid().

function ToStringOrDefault#

virtual String_t ToStringOrDefault(
    const String_t & defaultValue
)

Gets the parameter value as string if the parameter is readable.

Parameters:

• defaultValue The default value returned if the parameter is not readable.

Return: Returns the parameter value if the parameter is readable. Otherwise returns the default value.

Thread Safety:

The method accesses the parameter multiple times. These accesses are not synchronized by a lock.

Error Safety:

Can throw exceptions if reading the value fails.

Reimplements: Pylon::CArrayParameter::ToStringOrDefault

Otherwise returns the default value.