Pleora Technologies Inc. eBUS SDK v6.2.4.5552 API



PvGenCategory.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2011, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENCATEGORY_H__
8 #define __PVGENCATEGORY_H__
9 
10 #include <PvGenICamLib.h>
11 #include <PvGenTypes.h>
12 #include <PvGenApi.h>
13 
14 
15 namespace PvGenICamLib
16 {
17  class GenParameterArray;
18  class GenParameterInternal;
19  class GenParameterArrayManager;
20 }
21 
22 
23 class PvGenCategory
24 {
25 public:
26 
27 #ifndef EBUS_PYTHON_DOXYGEN
28  PV_GENICAM_API PvResult GetName( PvString &aName ) const;
29  PV_GENICAM_API PvResult GetToolTip( PvString &aToolTip ) const;
30  PV_GENICAM_API PvResult GetDescription( PvString &aDescription ) const;
31  PV_GENICAM_API PvResult GetDisplayName( PvString &aDisplayName ) const;
32  PV_GENICAM_API PvResult GetNameSpace( PvGenNameSpace &aNameSpace ) const;
33 
34  PV_GENICAM_API PvResult GetVisibility( PvGenVisibility &aVisibility ) const;
35  PV_GENICAM_API PvResult IsVisible( PvGenVisibility aCurrentVisibility, bool &aVisible ) const;
36  PV_GENICAM_API bool IsVisible( PvGenVisibility aCurrentVisibility ) const;
37 
38  PV_GENICAM_API PvResult IsImplemented( bool &aImplemented ) const;
39  PV_GENICAM_API bool IsImplemented() const;
40 #else
41  PvString GetName() const;
42  PvString GetToolTip() const;
43  PvString GetDescription() const;
44  PvString GetDisplayName() const;
45  PvGenNameSpace GetNameSpace() const;
46  PvGenVisibility GetVisibility() const;
47  bool IsVisible( PvGenVisibility aCurrentVisibility ) const;
48  bool IsImplemented() const;
49 #endif
50 
51  PV_GENICAM_API PV_GENAPI_NS::INode *GetNode();
52 
53 protected:
54 
55  PvGenCategory();
56  virtual ~PvGenCategory();
57 
58 #ifndef PV_GENERATING_DOXYGEN_DOC
59 
60  PvGenICamLib::GenParameterInternal *mThis;
61 
62  friend class PvGenICamLib::GenParameterArray;
63  friend class PvGenICamLib::GenParameterArrayManager;
64 
65 #endif // PV_GENERATING_DOXYGEN_DOC
66 
67 private:
68 
69  // Not implemented
70  PvGenCategory( const PvGenCategory & );
71  const PvGenCategory &operator=( const PvGenCategory & );
72 };
73 
74 #endif
PvGenCategory::PvGenCategory
PvGenCategory()
Constructor.
Definition: PvGenCategory.cpp:36
PvGenCategory::~PvGenCategory
virtual ~PvGenCategory()
Destructor.
Definition: PvGenCategory.cpp:45
PvGenVisibility
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:11
PvString
String class.
Definition: PvString.h:21
PvResult
Result information.
Definition: PvResult.h:13
PvGenCategory
GenICam category.
Definition: PvGenCategory.h:23
PvGenCategory::GetNode
GenApi_3_1::INode * GetNode()
Returns the GenApi node wrapped by this PvGenCategory.
Definition: PvGenCategory.cpp:473
PvGenCategory::GetVisibility
PvResult GetVisibility(PvGenVisibility &aVisibility) const
Get the category&#39;s recommended user level (visibility)
Definition: PvGenCategory.cpp:277
PvGenCategory::GetNameSpace
PvResult GetNameSpace(PvGenNameSpace &aNameSpace) const
Get the category&#39;s name space.
Definition: PvGenCategory.cpp:224
PvGenCategory::GetDescription
PvResult GetDescription(PvString &aDescription) const
Get the category&#39;s description.
Definition: PvGenCategory.cpp:144
PvGenTypes.h
GenICam feature-related constants.
PvGenCategory::GetName
PvResult GetName(PvString &aName) const
Get the category&#39;s name.
Definition: PvGenCategory.cpp:70
PvGenCategory::IsVisible
PvResult IsVisible(PvGenVisibility aCurrentVisibility, bool &aVisible) const
Test if the category is visible at the specified visibilty level.
Definition: PvGenCategory.cpp:338
PvGenCategory::IsImplemented
bool IsImplemented() const
Test if the category is implemented.
Definition: PvGenCategory.cpp:453
PvGenCategory::GetToolTip
PvResult GetToolTip(PvString &aToolTip) const
Get the category&#39;s tool tip.
Definition: PvGenCategory.cpp:106
PvGenCategory::GetDisplayName
PvResult GetDisplayName(PvString &aDisplayName) const
Get the category&#39;s display name.
Definition: PvGenCategory.cpp:186

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