doc/sdk/_pv_gen_enum_8h_source.html

 // *****************************************************************************

 //

 //     Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.

 //

 // *****************************************************************************


 #ifndef __PVGENENUM_H__

 #define __PVGENENUM_H__


 #include <PvGenParameter.h>

 #include <PvGenEnumEntry.h>


 class PvGenEnum : public PvGenParameter

 {

 public:


     PV_GENICAM_API PvResult SetValue( int64_t aValue );


     PV_GENICAM_API PvResult SetValue( const PvString &aValue );


     PV_GENICAM_API PvResult GetValue( PvString &aValue ) const;


     PV_GENICAM_API PvResult GetValue( int64_t &aValue ) const;


     PV_GENICAM_API PvResult GetEntriesCount( int64_t &aCount ) const;


     PV_GENICAM_API PvResult GetEntryByName( const PvString &aEntryName, const PvGenEnumEntry **aEntry ) const;


     PV_GENICAM_API PvResult GetEntryByIndex( int64_t aIndex, const PvGenEnumEntry **aEntry ) const;


     PV_GENICAM_API PvResult GetEntryByValue( int64_t aValue, const PvGenEnumEntry **aEntry ) const;


 protected:


     PvGenEnum();


     virtual ~PvGenEnum();


 private:


     // Not implemented

     PvGenEnum( const PvGenEnum & );

     const PvGenEnum &operator=( const PvGenEnum & );


 };


 #endif

PvGenEnumEntry
GenICam feature: Enumeration entry.
Definition: PvGenEnumEntry.h:28

PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:50

PvGenEnum::~PvGenEnum
virtual ~PvGenEnum()
Destructor.
Definition: PvGenEnum.cpp:40

PvGenEnum::GetEntryByName
PvResult GetEntryByName(const PvString &aEntryName, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by name).
Definition: PvGenEnum.cpp:176

PvGenEnum::GetEntryByIndex
PvResult GetEntryByIndex(int64_t aIndex, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by list position).
Definition: PvGenEnum.cpp:209

PvGenEnum::GetValue
PvResult GetValue(PvString &aValue) const
Get the feature's value (as a string).
Definition: PvGenEnum.cpp:101

PvGenEnum::GetEntriesCount
PvResult GetEntriesCount(int64_t &aCount) const
Get the number of enumaration entries.
Definition: PvGenEnum.cpp:151

PvGenEnum::PvGenEnum
PvGenEnum()
Constructor.
Definition: PvGenEnum.cpp:31

PvGenEnum::GetEntryByValue
PvResult GetEntryByValue(int64_t aValue, const PvGenEnumEntry **aEntry) const
Get an enumeration entry (by value).
Definition: PvGenEnum.cpp:239

PvGenEnum::SetValue
PvResult SetValue(int64_t aValue)
Set the feature's value.
Definition: PvGenEnum.cpp:49

PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:44

PvResult
Result information.
Definition: PvResult.h:30

PvString
String class.
Definition: PvString.h:26