Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenEnumEntry Class Reference

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.
 

Detailed Description

GenICam feature: Enumeration entry.

To use PvGenEnumEntry, see PvGenEnum.

Member Function Documentation

◆ GetDescription()

PvResult PvGenEnumEntry::GetDescription ( PvString aDescription) const

Get a longer description of the enum entry.

Parameters
[out]aDescriptionA longer description of the enum entry.
Returns
Includes:

◆ GetDisplayName()

PvResult PvGenEnumEntry::GetDisplayName ( PvString aDisplayName) const

Get the enum entry's display name.

Parameters
[out]aDisplayNameThe 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()

PvResult PvGenEnumEntry::GetName ( PvString aName) const

Get the enumeration entry's name.

Parameters
[out]aNameThe 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]aNameSpaceThe enum entry's name space.
Returns
Includes:

◆ GetToolTip()

PvResult PvGenEnumEntry::GetToolTip ( PvString aToolTip) const

Get a short description of the enum entry.

Parameters
[out]aToolTipA short description of the enum entry.
Returns
See GetDescription.

◆ GetValue()

PvResult PvGenEnumEntry::GetValue ( int64_t &  aValue) const

Get the enumeration entry's value.

Parameters
[out]aValueThe enumeration entry's value.
Returns
See GetDescription.
See also
PvGenEnum::GetValue

◆ GetVisibility()

PvResult PvGenEnumEntry::GetVisibility ( PvGenVisibility aVisibility) const

Get the enumeration entry's current visibility level.

See PvGenParameter::GetVisibility.

Parameters
[out]aVisibilitySee PvGenParameter::GetVisibility.
Returns
See GetDescription.
See also
PvGenParameter::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

Test if the enumeration entry is currently available.

See PvGenParameter::IsAvailable.

Parameters
[out]aAvailableSee PvGenParameter::IsAvailable.
Returns
See GetDescription.
See also
PvGenParameter::IsAvailable

◆ IsVisible() [1/2]

bool PvGenEnumEntry::IsVisible ( PvGenVisibility  aCurrentVisibility) const

Test if the parameter is visible at the specified visibilty level.

Parameters
[in]aCurrentVisibilitySee PvGenParameter::IsVisible.
Returns
True if the parameter is visible at the specified visibilty level.

◆ IsVisible() [2/2]

PvResult PvGenEnumEntry::IsVisible ( PvGenVisibility  aCurrentVisibility,
bool &  aVisible 
) const

Test if the enumeration entry is above a specific visibilty level.

See PvGenParameter::IsVisible.

Parameters
[in]aCurrentVisibilitySee PvGenParameter::IsVisible.
[out]aVisibleSee PvGenParameter::IsVisible.
Returns
See GetDescription.
See also
PvGenParameter::IsVisible

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com