Pylon::CEnumParameter#

CEnumParameter class used to simplify access to GenApi parameters.

#include <pylon/EnumParameter.h>

Inherits from Pylon::IEnumerationEx, Pylon::CParameter, GenApi::IEnumeration, Pylon::IValueEx, GenApi::IValue, GenApi::IBase

Inherited by Pylon::CEnumParameterT< EnumT >

Public Classes#

Public Functions#

Additional inherited members#

Public Functions inherited from Pylon::CParameter

Public Functions inherited from GenApi::IBase

Public Functions Documentation#

function CEnumParameter#

CEnumParameter()

Creates an empty CEnumParameter object.

Error Safety:

Does not throw C++ exceptions.

function CEnumParameter#

explicit CEnumParameter(
    GenApi::INode * pNode
)

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

explicit CEnumParameter(
    GenApi::IEnumeration * pEnumeration
)

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

Parameters:

• pEnumeration The node to attach.

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

Error Safety:

Does not throw C++ exceptions.

function CEnumParameter#

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

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

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

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

CEnumParameter(
    const CEnumParameter & rhs
)

Copies a CEnumParameter object.

Parameters:

• rhs The object to copy.

Error Safety:

Does not throw C++ exceptions.

function ~CEnumParameter#

virtual ~CEnumParameter()

Destroys the CEnumParameter 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::IEnumeration * pEnumeration
)

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

Parameters:

• pEnumeration The node to assign.

Return: Returns true if the node has been attached.

Error Safety:

Does not throw C++ exceptions.

function operator=#

CEnumParameter & operator=(
    const CEnumParameter & rhs
)

Assigns a CEnumParameter object.

Parameters:

• rhs The object to assign.

Error Safety:

Does not throw C++ exceptions.

function Equals#

virtual bool Equals(
    const CEnumParameter & 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::IEnumeration * pEnumeration
) const

Returns true if the attached node pointer is equal.

Parameters:

• pEnumeration 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 GetSymbolics#

virtual void GetSymbolics(
    GenApi::StringList_t & Symbolics
)

Get list of symbolic Values.

Reimplements: GenApi::IEnumeration::GetSymbolics

function GetEntries#

virtual void GetEntries(
    GenApi::NodeList_t & Entries
)

Get list of entry nodes.

Reimplements: GenApi::IEnumeration::GetEntries

function operator=#

virtual GenApi::IEnumeration & operator=(
    const GenICam::gcstring & ValueStr
)

Set string node value.

Reimplements: GenApi::IEnumeration::operator=

function SetIntValue#

virtual void SetIntValue(
    int64_t Value,
    bool Verify =true
)

Set integer node value.

Parameters:

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

Reimplements: GenApi::IEnumeration::SetIntValue

function operator*#

virtual GenICam::gcstring operator*()

Get string node value.

Reimplements: GenApi::IEnumeration::operator*

function GetIntValue#

virtual int64_t GetIntValue(
    bool Verify =false,
    bool IgnoreCache =false
)

Get integer 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::IEnumeration::GetIntValue

function GetEntryByName#

virtual GenApi::IEnumEntry * GetEntryByName(
    const GenICam::gcstring & Symbolic
)

Get an entry node by name.

Reimplements: GenApi::IEnumeration::GetEntryByName

function GetEntry#

virtual GenApi::IEnumEntry * GetEntry(
    const int64_t IntValue
)

Get an entry node by its IntValue.

Reimplements: GenApi::IEnumeration::GetEntry

function GetCurrentEntry#

virtual GenApi::IEnumEntry * GetCurrentEntry(
    bool Verify =false,
    bool IgnoreCache =false
)

Get the current entry.

Reimplements: GenApi::IEnumeration::GetCurrentEntry

function GetValueOrDefault#

virtual String_t GetValueOrDefault(
    const String_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 exceptions if reading the value fails.

Reimplements: Pylon::IEnumerationEx::GetValueOrDefault

Otherwise returns the default value.

function TrySetValue#

virtual bool TrySetValue(
    const String_t & value
)

Sets the value of the parameter if the parameter is writable and the value is contained in the set of settable enumeration values.

Parameters:

• value The value to set.

Return: Returns false if the parameter is not writable or the value is not contained in the set of settable enumeration values.

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

function SetValue#

virtual void SetValue(
    const char ** nullTerminatedList
)

Sets the value of the parameter to the first valid value in a list of values.

Parameters:

• nullTerminatedList The list of possible values to set. The list is terminated by a NULL value.

Precondition:

• The parameter must be writable.
• At least one value within the list passed must be contained in the set of settable enumeration values.

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, no value nullTerminatedList is settable, or writing the value fails.

Reimplements: Pylon::IEnumerationEx::SetValue

Example:

CEnumParameter pixelFormat(nodemap, "PixelFormat");
const char* list[] = { "BayerGR8", "BayerRG8", "BayerGB8", "BayerBG8", "Mono8", NULL };
pixelFormat.SetValue(list);

function TrySetValue#

virtual bool TrySetValue(
    const char ** nullTerminatedList
)

If the parameter is writable, sets the value of the parameter to the first valid value in a list of values.

Parameters:

• nullTerminatedList The list of possible values to set. The list is terminated by a NULL value.

Return: Returns false if the parameter is not writable.

Precondition: At least one value within the passed list must be contained in the set of settable enumeration values.

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, no value nullTerminatedList is settable, or writing the value fails.

Reimplements: Pylon::IEnumerationEx::TrySetValue

Example:

CEnumParameter pixelFormat(nodemap, "PixelFormat");
const char* list[] = { "BayerGR8", "BayerRG8", "BayerGB8", "BayerBG8", "Mono8", NULL };
pixelFormat.TrySetValue(list);

function CanSetValue#

virtual bool CanSetValue(
    const String_t & value
)

Indicates whether the given value can be set.

Parameters:

• value The value to be checked.

Return: Returns true if the value can be set, otherwise false.

Thread Safety:

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

Error Safety:

Does not throw exceptions.

Reimplements: Pylon::IEnumerationEx::CanSetValue

function SetValue#

virtual void SetValue(
    const String_t & value
)

Sets the value of the parameter.

Parameters:

• value The value to set.

Precondition: The value must be contained in the set of settable enumeration values.

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, no value is valid, or writing the value fails.

Reimplements: Pylon::IEnumerationEx::SetValue

Calls FromString().

function GetValue#

virtual String_t GetValue()

Gets the value of the parameter.

Return: Returns the current parameter value.

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 the parameter is not readable or if reading the value fails.

Reimplements: Pylon::IEnumerationEx::GetValue

function GetSettableValues#

virtual void GetSettableValues(
    GenApi::StringList_t & values
)

Gets a list of all values of the enumeration that are currently settable.

Parameters:

• values Returns a list of all values of the enumeration that are currently settable.

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.

Reimplements: Pylon::IEnumerationEx::GetSettableValues

function GetAllValues#

virtual void GetAllValues(
    GenApi::StringList_t & values
)

Gets a list of all values of the enumeration including the values that are currently not settable.

Parameters:

• values Returns a list of all values of the enumeration including the values that are currently not settable.

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.

Reimplements: Pylon::IEnumerationEx::GetAllValues

function GetEntryByNameAsParameter#

virtual CParameter GetEntryByNameAsParameter(
    const GenICam::gcstring & value
)

Gets an enumeration entry by its symbolic name.

Parameters:

• value The symbolic name of the enumeration entry, e.g., "Testimage1".

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.

Reimplements: Pylon::IEnumerationEx::GetEntryByNameAsParameter

The entry is returned as a CParameter. This method can be used to access information about the enumeration value represented by the entry using CParameter::GetInfo().

function GetCurrentEntryAsParameter#

virtual CParameter GetCurrentEntryAsParameter()

Gets the currently selected entry of an enumeration.

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.

Reimplements: Pylon::IEnumerationEx::GetCurrentEntryAsParameter

The entry is returned as a CParameter. This method can be used to access information about the enumeration value represented by the entry using CParameter::GetInfo().

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.