GenICam feature: Enumeration entry.
More...
GenICam feature: Enumeration entry.
To use PvGenEnumEntry, see PvGenEnum.
◆ GetDescription()
Get a longer description of the enum entry.
- Parameters
-
[out] | aDescription | A longer description of the enum entry. |
- Returns
- Includes:
◆ GetDisplayName()
Get the enum entry's display name.
- Parameters
-
[out] | aDisplayName | The enum entry's display name; a name that can be used to identify an enum entry in a user-interface context instead of GetName. |
- Returns
- Includes:
◆ GetName()
Get the enumeration entry's name.
- Parameters
-
[out] | aName | The enumeration entry's name |
- Returns
- See GetDescription.
- See also
- PvGenEnum::GetValueString
◆ GetNameSpace()
PvResult PvGenEnumEntry::GetNameSpace |
( |
PvGenNameSpace & |
aNameSpace | ) |
const |
Get the enum enty's name space.
- Parameters
-
[out] | aNameSpace | The enum entry's name space. |
- Returns
- Includes:
◆ GetToolTip()
Get a short description of the enum entry.
- Parameters
-
[out] | aToolTip | A short description of the enum entry. |
- Returns
- See GetDescription.
◆ GetValue()
PvResult PvGenEnumEntry::GetValue |
( |
int64_t & |
aValue | ) |
const |
◆ GetVisibility()
◆ IsAvailable() [1/2]
bool PvGenEnumEntry::IsAvailable |
( |
| ) |
const |
Test if the enumeration entry is currently available.
- Returns
- True if the enumeration entry is currently available.
- See also
- PvGenParameter::IsAvailable
◆ IsAvailable() [2/2]
PvResult PvGenEnumEntry::IsAvailable |
( |
bool & |
aAvailable | ) |
const |
◆ IsVisible() [1/2]
Test if the parameter is visible at the specified visibilty level.
- Parameters
-
- Returns
- True if the parameter is visible at the specified visibilty level.
◆ IsVisible() [2/2]
The documentation for this class was generated from the following files: