Pleora Technologies Inc. eBUS SDK v6.4.0.6670 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 
49 class PvGenEnum : public PvGenParameter
50 {
51 public:
52 
60  PV_GENICAM_API PvResult SetValue( int64_t aValue );
61 
69  PV_GENICAM_API PvResult SetValue( const PvString &aValue );
70 
78  PV_GENICAM_API PvResult GetValue( PvString &aValue ) const;
79 
87  PV_GENICAM_API PvResult GetValue( int64_t &aValue ) const;
88 
99  PV_GENICAM_API PvResult GetEntriesCount( int64_t &aCount ) const;
100 
114  PV_GENICAM_API PvResult GetEntryByName( const PvString &aEntryName, const PvGenEnumEntry **aEntry ) const;
115 
130  PV_GENICAM_API PvResult GetEntryByIndex( int64_t aIndex, const PvGenEnumEntry **aEntry ) const;
131 
144  PV_GENICAM_API PvResult GetEntryByValue( int64_t aValue, const PvGenEnumEntry **aEntry ) const;
145 
146 protected:
147 
151  PvGenEnum();
152 
156  virtual ~PvGenEnum();
157 
158 private:
159 
160  // Not implemented
161  PvGenEnum( const PvGenEnum & );
162  const PvGenEnum &operator=( const PvGenEnum & );
163 
164 };
165 
166 #endif
PvResult
Result information.
Definition: PvResult.h:29
PvGenEnumEntry
GenICam feature: Enumeration entry.
Definition: PvGenEnumEntry.h:27
PvGenEnum::PvGenEnum
PvGenEnum()
Constructor.
Definition: PvGenEnum.cpp:31
PvGenEnum::GetEntryByName
PvResult GetEntryByName(const PvString &aEntryName, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by name).
Definition: PvGenEnum.cpp:176
PvString
String class.
Definition: PvString.h:25
PvGenEnum::GetEntryByIndex
PvResult GetEntryByIndex(int64_t aIndex, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by list position).
Definition: PvGenEnum.cpp:209
PvGenEnum::SetValue
PvResult SetValue(int64_t aValue)
Set the feature's value.
Definition: PvGenEnum.cpp:49
PvGenEnum::GetValue
PvResult GetValue(PvString &aValue) const
Get the feature's value (as a string).
Definition: PvGenEnum.cpp:101
PvGenEnum::~PvGenEnum
virtual ~PvGenEnum()
Destructor.
Definition: PvGenEnum.cpp:40
PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:43
PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:49
PvGenEnum::GetEntryByValue
PvResult GetEntryByValue(int64_t aValue, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by value).
Definition: PvGenEnum.cpp:239
PvGenEnum::GetEntriesCount
PvResult GetEntriesCount(int64_t &aCount) const
Get the number of enumaration entries.
Definition: PvGenEnum.cpp:151

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