Pleora Technologies Inc. eBUS SDK v5.1.10.4642 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  PV_GENICAM_API PvResult SetValue( int64_t aValue );
19  PV_GENICAM_API PvResult SetValue( const PvString &aValue );
20  PV_GENICAM_API PvResult GetValue( PvString &aValue ) const;
21  PV_GENICAM_API PvResult GetValue( int64_t &aValue ) const;
22 
23  PV_GENICAM_API PvResult GetEntriesCount( int64_t &aCount ) const;
24  PV_GENICAM_API PvResult GetEntryByName( const PvString &aEntryName, const PvGenEnumEntry **aEntry ) const;
25  PV_GENICAM_API PvResult GetEntryByIndex( int64_t aIndex, const PvGenEnumEntry **aEntry ) const;
26  PV_GENICAM_API PvResult GetEntryByValue( int64_t aValue, const PvGenEnumEntry **aEntry ) const;
27 
28 protected:
29 
30  PvGenEnum();
31  virtual ~PvGenEnum();
32 
33 private:
34 
35  // Not implemented
36  PvGenEnum( const PvGenEnum & );
37  const PvGenEnum &operator=( const PvGenEnum & );
38 
39 };
40 
41 #endif
PvResult GetEntryByName(const PvString &aEntryName, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by name).
Definition: PvGenEnum.cpp:234
String class.
Definition: PvString.h:21
Result information.
Definition: PvResult.h:13
PvGenEnum()
Constructor.
Definition: PvGenEnum.cpp:57
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:14
PvResult GetValue(PvString &aValue) const
Get the feature&#39;s value (as a string).
Definition: PvGenEnum.cpp:139
GenICam feature: Enumeration entry.
Definition: PvGenEnumEntry.h:20
virtual ~PvGenEnum()
Destructor.
Definition: PvGenEnum.cpp:66
Base class for all GenICam feature types.
Definition: PvGenParameter.h:38
PvResult GetEntryByValue(int64_t aValue, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by value).
Definition: PvGenEnum.cpp:315
PvResult GetEntriesCount(int64_t &aCount) const
Get the number of enumaration entries.
Definition: PvGenEnum.cpp:200
PvResult SetValue(int64_t aValue)
Set the feature&#39;s value.
Definition: PvGenEnum.cpp:79
PvResult GetEntryByIndex(int64_t aIndex, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by list position).
Definition: PvGenEnum.cpp:276

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