![]() |
![]() |
A template class that is used to create classes derived from CEnumParameter. More...
#include <pylon/EnumParameterT.h>
Public Member Functions | |
virtual void | SetValue (EnumT value, bool verify=true)=0 |
Sets the value passed. More... | |
virtual IEnumParameterT< EnumT > & | operator= (EnumT value)=0 |
Sets the value passed. More... | |
virtual EnumT | GetValue (bool verify=false, bool ignoreCache=false)=0 |
Gets the current parameter value. More... | |
virtual EnumT | operator() ()=0 |
Gets the current parameter value. More... | |
virtual GenApi::IEnumEntry * | GetEntry (const EnumT value)=0 |
Returns the EnumEntry object belonging to the value. | |
virtual EnumT | GetValueOrDefault (EnumT defaultValue)=0 |
Gets the parameter value if the parameter is readable. More... | |
virtual bool | TrySetValue (EnumT value)=0 |
Sets the value passed if the parameter is writable and the value is contained in the set of settable enumeration values. More... | |
virtual bool | CanSetValue (EnumT value)=0 |
Indicates if the value passed can be set. More... | |
virtual String_t | GetValueOrDefault (const String_t &defaultValue)=0 |
Gets the value of the parameter if the parameter is readable. More... | |
virtual bool | TrySetValue (const String_t &value)=0 |
Sets the value of the parameter if the parameter is writable and the value is contained in the set of settable enumeration values. More... | |
virtual bool | TrySetValue (const char **nullTerminatedList)=0 |
If the parameter is writable, sets the value of the parameter to the first valid value in a list of values. More... | |
virtual void | SetValue (const char **nullTerminatedList)=0 |
Sets the value of the parameter to the first valid value in a list of values. More... | |
virtual void | SetValue (const String_t &value)=0 |
Sets the value of the parameter. More... | |
virtual bool | CanSetValue (const String_t &value)=0 |
Indicates whether the given value can be set. More... | |
virtual String_t | GetValue ()=0 |
Gets the value of the parameter. More... | |
virtual void | GetSettableValues (GenApi::StringList_t &values)=0 |
Gets a list of all values of the enumeration that are currently settable. More... | |
virtual void | GetAllValues (GenApi::StringList_t &values)=0 |
Gets a list of all values of the enumeration including the values that are currently not settable. More... | |
virtual CParameter | GetEntryByNameAsParameter (const GenICam::gcstring &value)=0 |
Gets an enumeration entry by its symbolic name. More... | |
virtual CParameter | GetCurrentEntryAsParameter ()=0 |
Gets the currently selected entry of an enumeration. More... | |
virtual void | GetSymbolics (StringList_t &Symbolics)=0 |
Get list of symbolic Values. | |
virtual void | GetEntries (NodeList_t &Entries)=0 |
Get list of entry nodes. | |
virtual void | SetIntValue (int64_t Value, bool Verify=true)=0 |
Set integer node value. More... | |
virtual GenICam::gcstring | operator* ()=0 |
Get string node value. | |
virtual int64_t | GetIntValue (bool Verify=false, bool IgnoreCache=false)=0 |
Get integer node value. More... | |
virtual IEnumEntry * | GetEntryByName (const GenICam::gcstring &Symbolic)=0 |
Get an entry node by name. | |
virtual IEnumEntry * | GetEntry (const int64_t IntValue)=0 |
Get an entry node by its IntValue. | |
virtual IEnumEntry * | GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0 |
Get the current entry. | |
virtual INode * | GetNode () |
Get the INode interface of the node. | |
virtual GenICam::gcstring | ToString (bool Verify=false, bool IgnoreCache=false)=0 |
Get content of the node as string. More... | |
virtual void | FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0 |
Set content of the node as string. More... | |
virtual bool | IsValueCacheValid () const =0 |
Checks if the value comes from cache or is requested from another node. | |
virtual EAccessMode | GetAccessMode () const =0 |
Get the access mode of the node. | |
virtual bool | IsReadable () const =0 |
Indicates whether the parameter is readable. More... | |
virtual bool | IsWritable () const =0 |
Indicates whether the parameter is writable. More... | |
virtual bool | IsValid () const =0 |
Indicates whether a node is attached. More... | |
virtual String_t | GetInfo (EParameterInfo info)=0 |
Gets the parameter information. More... | |
virtual String_t | GetInfoOrDefault (EParameterInfo info, const String_t defaultInfo)=0 |
Gets the parameter information if the parameter is attached to a node. More... | |
virtual String_t | ToStringOrDefault (const String_t &defaultValue)=0 |
Gets the parameter value as string if the parameter is readable. More... | |
A template class that is used to create classes derived from CEnumParameter.
The derived classes use C++ enums instead of strings as enumeration values. They are used for native parameter access.
|
pure virtualinherited |
Indicates whether the given value can be set.
[in] | value | The value to be checked. |
Implemented in Pylon::CEnumParameter.
|
pure virtual |
Indicates if the value passed can be set.
[in] | value | The value to be checked. |
|
pure virtualinherited |
Set content of the node as string.
ValueStr | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Gets a list of all values of the enumeration including the values that are currently not settable.
[out] | values | Returns a list of all values of the enumeration including the values that are currently not settable. |
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Gets the currently selected entry of an enumeration.
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().
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Gets an enumeration entry by its symbolic name.
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().
[in] | value | The symbolic name of the enumeration entry, e.g., "Testimage1". |
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Gets the parameter information.
[in] | info | The type information to return. |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Gets the parameter information if the parameter is attached to a node.
See IsValid().
[in] | info | The type information to return. Otherwise returns the default information. This method is useful if you want to display parameter information and handle the case that some parameters are not available for a device. |
[in] | defaultInfo | The default information returned if the parameter is not attached to a node. |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Get integer node value.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Gets a list of all values of the enumeration that are currently settable.
[out] | values | Returns a list of all values of the enumeration that are currently settable. |
Implemented in Pylon::CEnumParameter.
|
pure virtual |
Gets the current parameter value.
verify | Enables Range verification (default = false). The AccessMode is always checked. |
ignoreCache | If true, the value is read ignoring any caches (default = false). |
|
pure virtualinherited |
Gets the value of the parameter.
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Gets the value of the parameter if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
Implemented in Pylon::CEnumParameter.
|
pure virtual |
Gets the parameter value if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
|
pure virtualinherited |
Indicates whether the parameter is readable.
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Indicates whether a node is attached.
Implemented in Pylon::CFloatParameter, Pylon::CIntegerParameter, Pylon::CEnumParameter, Pylon::CParameter, Pylon::CStringParameter, Pylon::CBooleanParameter, Pylon::CCommandParameter, and Pylon::CArrayParameter.
|
pure virtualinherited |
Indicates whether the parameter is writable.
Implemented in Pylon::CParameter.
|
pure virtual |
Gets the current parameter value.
|
pure virtual |
Sets the value passed.
[in] | value | The value to set. |
|
pure virtualinherited |
Set integer node value.
Value | The value to set |
Verify | Enables AccessMode and Range verification (default = true) |
Implemented in Pylon::CEnumParameter.
|
pure virtual |
Sets the value passed.
[in] | value | The value to set. |
[in] | verify | Enables AccessMode and Range verification (default = true). |
|
pure virtualinherited |
Sets the value of the parameter to the first valid value in a list of values.
Example:
[in] | nullTerminatedList | The list of possible values to set. The list is terminated by a NULL value. |
nullTerminatedList
is settable, or writing the value fails. Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Sets the value of the parameter.
Calls FromString().
[in] | value | The value to set. |
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
Get content of the node as string.
Verify | Enables Range verification (default = false). The AccessMode is always checked |
IgnoreCache | If true the value is read ignoring any caches (default = false) |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Gets the parameter value as string if the parameter is readable.
Otherwise returns the default value.
[in] | defaultValue | The default value returned if the parameter is not readable. |
Implemented in Pylon::CParameter.
|
pure virtualinherited |
Sets the value of the parameter if the parameter is writable and the value is contained in the set of settable enumeration values.
[in] | value | The value to set. |
Implemented in Pylon::CEnumParameter.
|
pure virtualinherited |
If the parameter is writable, sets the value of the parameter to the first valid value in a list of values.
Example:
[in] | nullTerminatedList | The list of possible values to set. The list is terminated by a NULL value. |
nullTerminatedList
is settable, or writing the value fails. Implemented in Pylon::CEnumParameter.
|
pure virtual |
Sets the value passed if the parameter is writable and the value is contained in the set of settable enumeration values.
[in] | value | The value to set. |