eBUS SDK v6.2.8.5877 APIGenICam feature: Enumeration. A feature which can take one of many defined values. More...
Public Member Functions | |
| PvResult | SetValue (int64_t aValue) |
| Set the feature's value. More... | |
| PvResult | SetValue (const PvString &aValue) |
| Set feature's value. More... | |
| PvResult | GetValue (PvString &aValue) const |
| Get the feature's value (as a string). More... | |
| PvResult | GetValue (int64_t &aValue) const |
| Get the feature's value (as an integer). More... | |
| PvResult | GetEntriesCount (int64_t &aCount) const |
| Get the number of enumaration entries. More... | |
| PvResult | GetEntryByName (const PvString &aEntryName, const PvGenEnumEntry **aEntry) const |
| Get an enumeration entry (by name). More... | |
| PvResult | GetEntryByIndex (int64_t aIndex, const PvGenEnumEntry **aEntry) const |
| Get an enumeration entry (by list position). More... | |
| PvResult | GetEntryByValue (int64_t aValue, const PvGenEnumEntry **aEntry) const |
| Get an enumeration entry (by value). More... | |
 Public Member Functions inherited from PvGenParameter | |
| PvString | GetName () const |
| Get the parameter's name. More... | |
| PvResult | GetName (PvString &aName) const |
| Get the parameter's name. More... | |
| PvResult | GetType (PvGenType &aType) const |
| Get the parameter's type. More... | |
| PvResult | GetCategory (PvString &aCategory) const |
| Get the parameter's category. More... | |
| PvResult | GetToolTip (PvString &aToolTip) const |
| Get the parameter's tool tip. More... | |
| PvResult | GetDescription (PvString &aDescription) const |
| Get the parameter's description. More... | |
| PvResult | GetDisplayName (PvString &aDisplayName) const |
| Get the parameter's display name. More... | |
| PvResult | GetNameSpace (PvGenNameSpace &aNameSpace) const |
| Get the parameter's name space. More... | |
| PvResult | IsValueCached (bool &aCached) const |
| Test if the parameter's value is cached in the PC. More... | |
| PvResult | IsPersistent (bool &aPersistent) const |
| Test if the parameter is to be considered when saving the state of a GenICam interface to disk. More... | |
| PvResult | IsImplemented (bool &aImplemented) const |
| Test if the parameter is implemented. More... | |
| PvResult | IsAvailable (bool &aAvailable) const |
| Test if the parameter is currently available, but may be available latter on. More... | |
| PvResult | IsWritable (bool &aWritable) const |
| Test if the parameter is writable. More... | |
| PvResult | IsReadable (bool &aReadable) const |
| Test if the parameter is readable. More... | |
| PvResult | IsStreamable (bool &aStreamable) const |
| Test if the parameter is streamable. More... | |
| bool | IsValueCached () const |
| Test if the parameter's value is cached in the PC. More... | |
| bool | IsPersistent () const |
| Test if the parameter is to be considered when saving the state of a GenICam interface to disk. More... | |
| bool | IsImplemented () const |
| Test if the parameter is implemented. More... | |
| bool | IsAvailable () const |
| Test if the parameter is currently available, but may be available latter on. More... | |
| bool | IsWritable () const |
| Test if the parameter is writable. More... | |
| bool | IsReadable () const |
| Test if the parameter is readable. More... | |
| bool | IsVisible (PvGenVisibility aCurrentVisibility) const |
| Test if the parameter is visible at the specified visibilty level. More... | |
| bool | IsStreamable () const |
| Test if the parameter is streamable. More... | |
| PvResult | GetVisibility (PvGenVisibility &aVisibility) const |
| Get the parameter's recommended user level (visibility) More... | |
| PvResult | IsVisible (PvGenVisibility aCurrentVisibility, bool &aVisible) const |
| Test if the parameter is visible at the specified visibilty level. More... | |
| PvResult | IsSelector (bool &aSelector) const |
| Queries whether this parameter is a selector or not. More... | |
| PvResult | GetSelectedParameters (PvGenParameterList &aList) const |
| Returns all parameters selected by this parameter. More... | |
| PvResult | GetSelectingParameters (PvGenParameterList &aList) const |
| Returns all selectors for this parameter. More... | |
| PvResult | RegisterEventSink (PvGenEventSink *aEventSink) |
| Register an event sink interface that will be used for callbacks on this parameter. More... | |
| PvResult | UnregisterEventSink (PvGenEventSink *aEventSink) |
| Unregister an event sink. More... | |
| PvString | ToString () const |
| Gets the parameter value as a string. More... | |
| PvResult | ToString (PvString &aValue) const |
| Gets the parameter value as a string. More... | |
| PvResult | FromString (const PvString &aValue) |
| Sets the parameter value from a string. More... | |
| GenApi_3_3::INode * | GetNode () |
| Returns the GenApi node wrapped by this PvGenParameter. More... | |
| bool | GetUpdatesEnabled () |
| Returns true if parameter update notifications are temporarily disabled. More... | |
| void | SetUpdatesEnabled (bool aEnabled) |
| Temporarily disable (or re-enable) parameter update notifications. More... | |
Protected Member Functions | |
| PvGenEnum () | |
| Constructor. | |
| virtual | ~PvGenEnum () |
| Destructor. | |
| Protected Member Functions inherited from PvGenParameter | |
| PvGenParameter () | |
| Constructor. | |
| virtual | ~PvGenParameter () |
| Destructor. | |
GenICam feature: Enumeration. A feature which can take one of many defined values.
PvGenEnum is a list of selectable values. In a UI, PvGenEnum objects are typically represented as dropdown lists.
Each list entry is a PvGenEnumEntry object.
Thus, the enumeration list might be represented as:
| List position | Entry value | Entry name |
|---|---|---|
| 0 | 5 | Orange |
| 1 | 4 | Apple |
| 2 | 99 | Watermelon |
However, the UI presents only a selection of entry names (Orange, etc.); the list position and entry values are hidden. The entry names are always unique.
Enumerations can't be set to any arbitrary value; they can only be set to a value of an entry on the list. If a user selected Orange, you could set the new value in the following ways:
| PvResult PvGenEnum::GetEntriesCount | ( | int64_t & | aCount | ) | const |
Get the number of enumaration entries.
| [out] | aCount | The number of enumeration entries. |
| PvResult PvGenEnum::GetEntryByIndex | ( | int64_t | aIndex, |
| const PvGenEnumEntry ** | aEntry | ||
| ) | const |
Get an enumeration entry (by list position).
| [in] | aIndex | The enumeration entry's position in the list. The enumerator (PvGenEnum object) has a list that ranges from 0 to PvGenEnum::GetEntriesCount. |
| [out] | aEntry | A pointer to the enumeration entry. |
| PvResult PvGenEnum::GetEntryByName | ( | const PvString & | aEntryName, |
| const PvGenEnumEntry ** | aEntry | ||
| ) | const |
Get an enumeration entry (by name).
| [in] | aEntryName | The enumeration entry's name (PvGenEnumEntry::GetName). |
| [out] | aEntry | A pointer to the enumeration entry. |
| PvResult PvGenEnum::GetEntryByValue | ( | int64_t | aValue, |
| const PvGenEnumEntry ** | aEntry | ||
| ) | const |
Get an enumeration entry (by value).
| [in] | aValue | The enumeration entry's value (PvGenEnumEntry::GetValue). |
| [out] | aEntry | A pointer to the enumeration entry. |
Get the feature's value (as a string).
| [out] | aValue | The feature's value (equivalent to PvGenEnumEntry::GetName). |
| PvResult PvGenEnum::GetValue | ( | int64_t & | aValue | ) | const |
Get the feature's value (as an integer).
| [out] | aValue | The feature's value (equivalent to PvGenEnumEntry::GetValue). |
| PvResult PvGenEnum::SetValue | ( | int64_t | aValue | ) |
Set the feature's value.
| [in] | aValue | The enumerator entry's feature's value (PvGenEnumEntry::GetValue). |
Set feature's value.
| [in] | aValue | The enumerator entry's name (PvGenEnumEntry::GetName). |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com