Pleora Technologies Inc. eBUS SDK v6.2.4.5552 API



PvGenEnumEntry.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENENUMENTRY_H__
8 #define __PVGENENUMENTRY_H__
9 
10 #include <PvGenICamLib.h>
11 #include <PvGenTypes.h>
12 
13 
14 namespace PvGenICamLib
15 {
16  class GenEnumEntryInternal;
17 }
18 
19 
20 class PvGenEnumEntry
21 {
22 public:
23 
24 #ifndef EBUS_PYTHON_DOXYGEN
25  PV_GENICAM_API PvResult GetValue( int64_t &aValue ) const;
26  PV_GENICAM_API PvResult GetName( PvString &aName ) const;
27 
28  PV_GENICAM_API PvResult GetToolTip( PvString &aToolTip ) const;
29  PV_GENICAM_API PvResult GetDescription( PvString &aDescription ) const;
30  PV_GENICAM_API PvResult GetVisibility( PvGenVisibility &aVisibility ) const;
31  PV_GENICAM_API PvResult GetDisplayName( PvString &aDisplayName ) const;
32  PV_GENICAM_API PvResult GetNameSpace( PvGenNameSpace &aNameSpace ) const;
33 
34  PV_GENICAM_API PvResult IsVisible( PvGenVisibility aVisibility, bool &aVisible ) const;
35  PV_GENICAM_API PvResult IsAvailable( bool &aAvailable ) const;
36 
37  PV_GENICAM_API bool IsVisible( PvGenVisibility aVisibility ) const;
38  PV_GENICAM_API bool IsAvailable() const;
39 #else
40  int64_t GetValue() const;
41  PvString GetName() const;
42  PvString GetToolTip() const;
43  PvString GetDescription() const;
44  PvGenVisibility GetVisibility() const;
45  PvString GetDisplayName() const;
46  PvGenNameSpace GetNameSpace() const;
47  bool IsVisible( PvGenVisibility aVisibility ) const;
48  bool IsAvailable() const;
49 #endif
50 
51 protected:
52 
53  PvGenEnumEntry();
54  virtual ~PvGenEnumEntry();
55 
56  PvGenICamLib::GenEnumEntryInternal *mThis;
57 
58 private:
59 
60 };
61 
62 #endif
PvGenEnumEntry::GetDescription
PvResult GetDescription(PvString &aDescription) const
Get a longer description of the enum entry.
Definition: PvGenEnumEntry.cpp:171
PvGenEnumEntry::~PvGenEnumEntry
virtual ~PvGenEnumEntry()
Destructor.
Definition: PvGenEnumEntry.cpp:40
PvGenVisibility
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:11
PvGenEnumEntry::PvGenEnumEntry
PvGenEnumEntry()
Constructor.
Definition: PvGenEnumEntry.cpp:32
PvGenEnumEntry::GetValue
PvResult GetValue(int64_t &aValue) const
Get the enumeration entry&#39;s value.
Definition: PvGenEnumEntry.cpp:65
PvString
String class.
Definition: PvString.h:21
PvResult
Result information.
Definition: PvResult.h:13
PvGenEnumEntry::GetDisplayName
PvResult GetDisplayName(PvString &aDisplayName) const
Get the enum entry&#39;s display name.
Definition: PvGenEnumEntry.cpp:396
PvGenEnumEntry
GenICam feature: Enumeration entry.
Definition: PvGenEnumEntry.h:20
PvGenTypes.h
GenICam feature-related constants.
PvGenEnumEntry::GetVisibility
PvResult GetVisibility(PvGenVisibility &aVisibility) const
Get the enumeration entry&#39;s current visibility level.
Definition: PvGenEnumEntry.cpp:260
PvGenEnumEntry::GetNameSpace
PvResult GetNameSpace(PvGenNameSpace &aNameSpace) const
Get the enum enty&#39;s name space.
Definition: PvGenEnumEntry.cpp:432
PvGenEnumEntry::IsVisible
PvResult IsVisible(PvGenVisibility aVisibility, bool &aVisible) const
Test if the enumeration entry is above a specific visibilty level.
Definition: PvGenEnumEntry.cpp:317
PvGenEnumEntry::IsAvailable
bool IsAvailable() const
Test if the enumeration entry is currently available.
Definition: PvGenEnumEntry.cpp:235
PvGenEnumEntry::GetToolTip
PvResult GetToolTip(PvString &aToolTip) const
Get a short description of the enum entry.
Definition: PvGenEnumEntry.cpp:135
PvGenEnumEntry::GetName
PvResult GetName(PvString &aName) const
Get the enumeration entry&#39;s name.
Definition: PvGenEnumEntry.cpp:101

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