Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenEnum.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENENUM_H__
8 #define __PVGENENUM_H__
9 
10 #include <PvGenParameter.h>
11 #include <PvGenEnumEntry.h>
12 
13 
14 class PvGenEnum : public PvGenParameter
15 {
16 public:
17 
18 #ifndef EBUS_PYTHON_DOXYGEN
19  PV_GENICAM_API PvResult SetValue( int64_t aValue );
20  PV_GENICAM_API PvResult SetValue( const PvString &aValue );
21  PV_GENICAM_API PvResult GetValue( PvString &aValue ) const;
22  PV_GENICAM_API PvResult GetValue( int64_t &aValue ) const;
23 
24  PV_GENICAM_API PvResult GetEntriesCount( int64_t &aCount ) const;
25  PV_GENICAM_API PvResult GetEntryByName( const PvString &aEntryName, const PvGenEnumEntry **aEntry ) const;
26  PV_GENICAM_API PvResult GetEntryByIndex( int64_t aIndex, const PvGenEnumEntry **aEntry ) const;
27  PV_GENICAM_API PvResult GetEntryByValue( int64_t aValue, const PvGenEnumEntry **aEntry ) const;
28 #else
29  PvResult SetValue(arg aValue);
30  PvString GetValueString();
31  int64_t GetValueInt();
32 
33  int64_t GetEntriesCount() const;
34  PvGenEnumEntry GetEntryByName( const PvString &aEntryName );
35  PvGenEnumEntry GetEntryByIndex( int64_t aIndex );
36  PvGenEnumEntry GetEntryByValue( int64_t aValue );
37 #endif
38 
39 protected:
40 
41  PvGenEnum();
42  virtual ~PvGenEnum();
43 
44 private:
45 
46  // Not implemented
47  PvGenEnum( const PvGenEnum & );
48  const PvGenEnum &operator=( const PvGenEnum & );
49 
50 };
51 
52 #endif
PvResult
Result information.
Definition: PvResult.h:13
PvGenEnumEntry
GenICam feature: Enumeration entry.
Definition: PvGenEnumEntry.h:20
PvGenEnum::PvGenEnum
PvGenEnum()
Constructor.
Definition: PvGenEnum.cpp:57
PvGenEnum::GetEntryByName
PvResult GetEntryByName(const PvString &aEntryName, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by name).
Definition: PvGenEnum.cpp:267
PvString
String class.
Definition: PvString.h:21
PvGenEnum::GetEntryByIndex
PvResult GetEntryByIndex(int64_t aIndex, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by list position).
Definition: PvGenEnum.cpp:314
PvGenEnum::SetValue
PvResult SetValue(int64_t aValue)
Set the feature's value.
Definition: PvGenEnum.cpp:88
PvGenEnum::GetValue
PvResult GetValue(PvString &aValue) const
Get the feature's value (as a string).
Definition: PvGenEnum.cpp:161
PvGenEnum::~PvGenEnum
virtual ~PvGenEnum()
Destructor.
Definition: PvGenEnum.cpp:66
PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:37
PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:14
PvGenEnum::GetEntryByValue
PvResult GetEntryByValue(int64_t aValue, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by value).
Definition: PvGenEnum.cpp:357
PvGenEnum::GetEntriesCount
PvResult GetEntriesCount(int64_t &aCount) const
Get the number of enumaration entries.
Definition: PvGenEnum.cpp:228

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