GenICam feature: Enumeration entry. More...
Public Member Functions | |
PvResult | GetValue (int64_t &aValue) const |
Get the enumeration entry's value. More... | |
PvResult | GetName (PvString &aName) const |
Get the enumeration entry's name. More... | |
PvResult | GetToolTip (PvString &aToolTip) const |
Get a short description of the enum entry. More... | |
PvResult | GetDescription (PvString &aDescription) const |
Get a longer description of the enum entry. More... | |
PvResult | GetVisibility (PvGenVisibility &aVisibility) const |
Get the enumeration entry's current visibility level. More... | |
PvResult | GetDisplayName (PvString &aDisplayName) const |
Get the enum entry's display name. More... | |
PvResult | GetNameSpace (PvGenNameSpace &aNameSpace) const |
Get the enum enty's name space. More... | |
PvResult | IsVisible (PvGenVisibility aVisibility, bool &aVisible) const |
Test if the enumeration entry is above a specific visibilty level. More... | |
PvResult | IsAvailable (bool &aAvailable) const |
Test if the enumeration entry is currently available. More... | |
bool | IsVisible (PvGenVisibility aVisibility) const |
Test if the parameter is visible at the specified visibilty level. More... | |
bool | IsAvailable () const |
Test if the enumeration entry is currently available. More... | |
Protected Member Functions | |
PvGenEnumEntry () | |
Constructor. | |
virtual | ~PvGenEnumEntry () |
Destructor. | |
GenICam feature: Enumeration entry.
To use PvGenEnumEntry, see PvGenEnum.
Get a longer description of the enum entry.
[out] | aDescription | A longer description of the enum entry. |
Get the enum entry's display name.
[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. |
Get the enumeration entry's name.
[out] | aName | The enumeration entry's name |
PvResult PvGenEnumEntry::GetNameSpace | ( | PvGenNameSpace & | aNameSpace | ) | const |
Get the enum enty's name space.
[out] | aNameSpace | The enum entry's name space. |
Get a short description of the enum entry.
[out] | aToolTip | A short description of the enum entry. |
PvResult PvGenEnumEntry::GetValue | ( | int64_t & | aValue | ) | const |
Get the enumeration entry's value.
[out] | aValue | The enumeration entry's value. |
PvResult PvGenEnumEntry::GetVisibility | ( | PvGenVisibility & | aVisibility | ) | const |
Get the enumeration entry's current visibility level.
See PvGenParameter::GetVisibility.
[out] | aVisibility | See PvGenParameter::GetVisibility. |
PvResult PvGenEnumEntry::IsAvailable | ( | bool & | aAvailable | ) | const |
Test if the enumeration entry is currently available.
See PvGenParameter::IsAvailable.
[out] | aAvailable | See PvGenParameter::IsAvailable. |
bool PvGenEnumEntry::IsAvailable | ( | ) | const |
Test if the enumeration entry is currently available.
PvResult PvGenEnumEntry::IsVisible | ( | PvGenVisibility | aCurrentVisibility, |
bool & | aVisible | ||
) | const |
Test if the enumeration entry is above a specific visibilty level.
See PvGenParameter::IsVisible.
[in] | aCurrentVisibility | See PvGenParameter::IsVisible. |
[out] | aVisible | See PvGenParameter::IsVisible. |
bool PvGenEnumEntry::IsVisible | ( | PvGenVisibility | aCurrentVisibility | ) | const |
Test if the parameter is visible at the specified visibilty level.
[in] | aCurrentVisibility | See PvGenParameter::IsVisible. |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com