Pleora Technologies Inc. eBUS SDK v6.4.0.6670 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 
29 class PvGenCategory
30 {
31 public:
32 
43  PV_GENICAM_API PvResult GetName( PvString &aName ) const;
44 
55  PV_GENICAM_API PvResult GetToolTip( PvString &aToolTip ) const;
56 
69  PV_GENICAM_API PvResult GetDescription( PvString &aDescription ) const;
70 
85  PV_GENICAM_API PvResult GetDisplayName( PvString &aDisplayName ) const;
86 
99  PV_GENICAM_API PvResult GetNameSpace( PvGenNameSpace &aNameSpace ) const;
100 
115  PV_GENICAM_API PvResult GetVisibility( PvGenVisibility &aVisibility ) const;
116 
132  PV_GENICAM_API PvResult IsVisible( PvGenVisibility aCurrentVisibility, bool &aVisible ) const;
133 
141  PV_GENICAM_API bool IsVisible( PvGenVisibility aCurrentVisibility ) const;
142 
157  PV_GENICAM_API PvResult IsImplemented( bool &aImplemented ) const;
158 
168  PV_GENICAM_API bool IsImplemented() const;
169 
181  PV_GENICAM_API PV_GENAPI_NS::INode *GetNode();
182 
183 protected:
184 
188  PvGenCategory();
189 
193  virtual ~PvGenCategory();
194 
195 #ifndef PV_GENERATING_DOXYGEN_DOC
196 
197  PvGenICamLib::GenParameterInternal *mThis;
198 
199  friend class PvGenICamLib::GenParameterArray;
200  friend class PvGenICamLib::GenParameterArrayManager;
201 
202 #endif // PV_GENERATING_DOXYGEN_DOC
203 
204 private:
205 
206  // Not implemented
207  PvGenCategory( const PvGenCategory & );
208  const PvGenCategory &operator=( const PvGenCategory & );
209 };
210 
211 #endif
PvGenTypes.h
GenICam feature-related constants.
PvGenVisibility
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:61
PvGenCategory
GenICam category.
Definition: PvGenCategory.h:30
PvGenCategory::GetToolTip
PvResult GetToolTip(PvString &aToolTip) const
Get the category's tool tip.
Definition: PvGenCategory.cpp:80
PvGenCategory::~PvGenCategory
virtual ~PvGenCategory()
Destructor.
Definition: PvGenCategory.cpp:41
PvGenCategory::GetVisibility
PvResult GetVisibility(PvGenVisibility &aVisibility) const
Get the category's recommended user level (visibility)
Definition: PvGenCategory.cpp:193
PvGenCategory::GetNameSpace
PvResult GetNameSpace(PvGenNameSpace &aNameSpace) const
Get the category's name space.
Definition: PvGenCategory.cpp:155
PvGenCategory::GetDescription
PvResult GetDescription(PvString &aDescription) const
Get the category's description.
Definition: PvGenCategory.cpp:105
PvGenCategory::GetDisplayName
PvResult GetDisplayName(PvString &aDisplayName) const
Get the category's display name.
Definition: PvGenCategory.cpp:130
PvGenCategory::IsVisible
PvResult IsVisible(PvGenVisibility aCurrentVisibility, bool &aVisible) const
Test if the category is visible at the specified visibilty level.
Definition: PvGenCategory.cpp:252
PvGenCategory::PvGenCategory
PvGenCategory()
Constructor.
Definition: PvGenCategory.cpp:32
PvGenCategory::IsImplemented
bool IsImplemented() const
Test if the category is implemented.
Definition: PvGenCategory.cpp:340
PvGenCategory::GetNode
PV_GENAPI_NS::INode * GetNode()
Returns the GenApi node wrapped by this PvGenCategory.
Definition: PvGenCategory.cpp:352
PvGenCategory::GetName
PvResult GetName(PvString &aName) const
Get the category's name.
Definition: PvGenCategory.cpp:55
PvResult
Result information.
Definition: PvResult.h:30
PvString
String class.
Definition: PvString.h:26

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