Pylon::CIntegerParameter#

CIntegerParameter class used to simplify access to GenApi parameters.

#include <pylon/IntegerParameter.h>

Inherits from Pylon::IIntegerEx, Pylon::CParameter, GenApi::IInteger, 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 CIntegerParameter#

CIntegerParameter()

Creates an empty CIntegerParameter object.

Error Safety:

Does not throw C++ exceptions.

function CIntegerParameter#

explicit CIntegerParameter(
    GenApi::INode * pNode
)

Creates a CIntegerParameter 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 CIntegerParameter#

explicit CIntegerParameter(
    GenApi::IInteger * pInteger
)

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

Parameters:

• pInteger The node to attach.

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

Error Safety:

Does not throw C++ exceptions.

function CIntegerParameter#

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

Creates a CIntegerParameter 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 CIntegerParameter#

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

Creates a CIntegerParameter 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 CIntegerParameter#

CIntegerParameter(
    const CIntegerParameter & rhs
)

Copies a CIntegerParameter object.

Parameters:

• rhs The object to copy.

Error Safety:

Does not throw C++ exceptions.

function ~CIntegerParameter#

virtual ~CIntegerParameter()

Destroys the CIntegerParameter 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::IInteger * pInteger
)

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

Parameters:

• pInteger The node to assign.

Return: Returns true if the node has been attached.

Error Safety:

Does not throw C++ exceptions.

function operator=#

CIntegerParameter & operator=(
    const CIntegerParameter & rhs
)

Assigns a CIntegerParameter object.

Parameters:

• rhs The object to assign.

Error Safety:

Does not throw C++ exceptions.

function Equals#

virtual bool Equals(
    const CIntegerParameter & 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::IInteger * pInteger
) const

Returns true if the attached node pointer is equal.

Parameters:

• pInteger 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(
    int64_t Value,
    bool Verify =true
)

Set node value.

Parameters:

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

Reimplements: GenApi::IInteger::SetValue

function operator=#

virtual GenApi::IInteger & operator=(
    int64_t Value
)

Set node value.

Reimplements: GenApi::IInteger::operator=

function GetValue#

virtual int64_t 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::IInteger::GetValue

function operator()#

virtual int64_t operator()()

Get node value.

Reimplements: GenApi::IInteger::operator())

function operator*#

virtual int64_t operator*()

Get node value.

Reimplements: GenApi::IInteger::operator*

function GetMin#

virtual int64_t GetMin()

Get minimum value allowed.

Reimplements: GenApi::IInteger::GetMin

function GetMax#

virtual int64_t GetMax()

Get maximum value allowed.

Reimplements: GenApi::IInteger::GetMax

function GetIncMode#

virtual GenApi::EIncMode GetIncMode()

Get increment mode.

Reimplements: GenApi::IInteger::GetIncMode

function GetInc#

virtual int64_t GetInc()

Get increment.

Reimplements: GenApi::IInteger::GetInc

function GetListOfValidValues#

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

Get list of valid value.

Reimplements: GenApi::IInteger::GetListOfValidValues

function GetRepresentation#

virtual GenApi::ERepresentation GetRepresentation()

Get recommended representation.

Reimplements: GenApi::IInteger::GetRepresentation

function GetUnit#

virtual GenICam::gcstring GetUnit()

Get the physical unit name.

Reimplements: GenApi::IInteger::GetUnit

function ImposeMin#

virtual void ImposeMin(
    int64_t Value
)

Restrict minimum value.

Reimplements: GenApi::IInteger::ImposeMin

function ImposeMax#

virtual void ImposeMax(
    int64_t Value
)

Restrict maximum value.

Reimplements: GenApi::IInteger::ImposeMax

function TrySetValue#

virtual bool TrySetValue(
    int64_t 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::IInteger::GetMin().
• The passed value must be <= GenApi::IInteger::GetMax().
• The passed value must be aligned to the increment returned by GenApi::IInteger::GetInc().

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::IIntegerEx::TrySetValue

The value must be in the valid range and the increment must be correct.

function GetValueOrDefault#

virtual int64_t GetValueOrDefault(
    int64_t 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::IIntegerEx::GetValueOrDefault

Otherwise returns the default value.

function TrySetValue#

virtual bool TrySetValue(
    int64_t value,
    EIntegerValueCorrection 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::IInteger*, int64_t) if correction equals IntegerValueCorrection_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::IIntegerEx::TrySetValue

The value is automatically corrected if needed.

function SetValue#

virtual void SetValue(
    int64_t value,
    EIntegerValueCorrection correction
)

Sets the value of the parameter.

Parameters:

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

Note Calls GenApi::IInteger::SetValue(int64_t) if correction equals IntegerValueCorrection_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::IIntegerEx::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::IIntegerEx::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::IIntegerEx::SetValuePercentOfRange

The value is always corrected to the nearest valid value.

The parameter must be writable.

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 to be used in the calculation.

Return: Returns true if the a 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::IIntegerEx::TrySetValuePercentOfRange

The value is always corrected to the nearest valid value.

function SetToMaximum#

virtual void SetToMaximum()

Sets the value of the parameter 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::IIntegerEx::SetToMaximum

function SetToMinimum#

virtual void SetToMinimum()

Sets the value of the parameter 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::IIntegerEx::SetToMinimum

function TrySetToMaximum#

virtual bool TrySetToMaximum()

Sets the value of the parameter 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::IIntegerEx::TrySetToMaximum

function TrySetToMinimum#

virtual bool TrySetToMinimum()

Sets the value of the parameter 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::IIntegerEx::TrySetToMinimum

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.