Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
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
14namespace PvGenICamLib
15{
16 class GenEnumEntryInternal;
17}
18
19
27class PvGenEnumEntry
28{
29public:
30
40 PV_GENICAM_API PvResult GetValue( int64_t &aValue ) const;
41
51 PV_GENICAM_API PvResult GetName( PvString &aName ) const;
52
60 PV_GENICAM_API PvResult GetToolTip( PvString &aToolTip ) const;
61
72 PV_GENICAM_API PvResult GetDescription( PvString &aDescription ) const;
73
85 PV_GENICAM_API PvResult GetVisibility( PvGenVisibility &aVisibility ) const;
86
99 PV_GENICAM_API PvResult GetDisplayName( PvString &aDisplayName ) const;
100
111 PV_GENICAM_API PvResult GetNameSpace( PvGenNameSpace &aNameSpace ) const;
112
125 PV_GENICAM_API PvResult IsVisible( PvGenVisibility aVisibility, bool &aVisible ) const;
126
138 PV_GENICAM_API PvResult IsAvailable( bool &aAvailable ) const;
139
147 PV_GENICAM_API bool IsVisible( PvGenVisibility aVisibility ) const;
148
156 PV_GENICAM_API bool IsAvailable() const;
157
158protected:
159
163 PvGenEnumEntry();
164
168 virtual ~PvGenEnumEntry();
169
170 PvGenICamLib::GenEnumEntryInternal *mThis;
171
172private:
173
174};
175
176#endif
PvGenTypes.h
GenICam feature-related constants.
PvGenVisibility
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition PvGenTypes.h:43
PvGenNameSpace
PvGenNameSpace
Definition PvGenTypes.h:147
PvGenEnumEntry
GenICam feature: Enumeration entry.
Definition PvGenEnumEntry.h:28
PvGenEnumEntry::GetNameSpace
PvResult GetNameSpace(PvGenNameSpace &aNameSpace) const
Get the enum enty's name space.
Definition PvGenEnumEntry.cpp:318
PvGenEnumEntry::IsAvailable
bool IsAvailable() const
Test if the enumeration entry is currently available.
Definition PvGenEnumEntry.cpp:175
PvGenEnumEntry::IsVisible
PvResult IsVisible(PvGenVisibility aVisibility, bool &aVisible) const
Test if the enumeration entry is above a specific visibilty level.
Definition PvGenEnumEntry.cpp:233
PvGenEnumEntry::GetToolTip
PvResult GetToolTip(PvString &aToolTip) const
Get a short description of the enum entry.
Definition PvGenEnumEntry.cpp:100
PvGenEnumEntry::GetDisplayName
PvResult GetDisplayName(PvString &aDisplayName) const
Get the enum entry's display name.
Definition PvGenEnumEntry.cpp:293
PvGenEnumEntry::GetVisibility
PvResult GetVisibility(PvGenVisibility &aVisibility) const
Get the enumeration entry's current visibility level.
Definition PvGenEnumEntry.cpp:187
PvGenEnumEntry::PvGenEnumEntry
PvGenEnumEntry()
Constructor.
Definition PvGenEnumEntry.cpp:28
PvGenEnumEntry::~PvGenEnumEntry
virtual ~PvGenEnumEntry()
Destructor.
Definition PvGenEnumEntry.cpp:36
PvGenEnumEntry::GetDescription
PvResult GetDescription(PvString &aDescription) const
Get a longer description of the enum entry.
Definition PvGenEnumEntry.cpp:125
PvGenEnumEntry::GetValue
PvResult GetValue(int64_t &aValue) const
Get the enumeration entry's value.
Definition PvGenEnumEntry.cpp:50
PvGenEnumEntry::GetName
PvResult GetName(PvString &aName) const
Get the enumeration entry's name.
Definition PvGenEnumEntry.cpp:75
PvResult
Result information.
Definition PvResult.h:30
PvString
String class.
Definition PvString.h:26

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