Pleora Technologies Inc. eBUS SDK v6.4.0.6670 API



PvGenParameter.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENPARAMETER_H__
8 #define __PVGENPARAMETER_H__
9 
10 #include <PvGenICamLib.h>
11 #include <PvGenParameterList.h>
12 #include <PvGenTypes.h>
13 #include <PvGenApi.h>
14 
15 
16 class PvGenEventSink;
17 class PvGenParameterList;
18 
19 namespace PvGenICamLib
20 {
21  class GenParameterArray;
22  class GenParameterInternal;
23  class GenParameterArrayManager;
24 }
25 
26 
27 #ifdef PV_INTERNAL_HEADERS
28  class PvGenBoolean;
29  class PvGenCommand;
30  class PvGenEnum;
31  class PvGenFloat;
32  class PvGenInteger;
33  class PvGenRegister;
34  class PvGenString;
35 #endif // PV_INTERNAL_HEADERS
36 
37 
43 class PvGenParameter
44 {
45 public:
46 
52  PV_GENICAM_API PvString GetName() const;
53 
61  PV_GENICAM_API PvResult GetName( PvString &aName ) const;
62 
72  PV_GENICAM_API PvResult GetType( PvGenType &aType ) const;
73 
84  PV_GENICAM_API PvResult GetCategory( PvString &aCategory ) const;
85 
96  PV_GENICAM_API PvResult GetToolTip( PvString &aToolTip ) const;
97 
111  PV_GENICAM_API PvResult GetDescription( PvString &aDescription ) const;
112 
127  PV_GENICAM_API PvResult GetDisplayName( PvString &aDisplayName ) const;
128 
141  PV_GENICAM_API PvResult GetNameSpace( PvGenNameSpace &aNameSpace ) const;
142 
155  PV_GENICAM_API PvResult IsValueCached( bool &aCached ) const;
156 
175  PV_GENICAM_API PvResult IsPersistent( bool &aPersistent ) const;
176 
191  PV_GENICAM_API PvResult IsImplemented( bool &aImplemented ) const;
192 
203  PV_GENICAM_API PvResult IsAvailable( bool &aAvailable ) const;
204 
215  PV_GENICAM_API PvResult IsWritable( bool &aWritable ) const;
216 
230  PV_GENICAM_API PvResult IsReadable( bool &aReadable ) const;
231 
245  PV_GENICAM_API PvResult IsStreamable( bool &aStreamable ) const;
246 
255  PV_GENICAM_API bool IsValueCached() const;
256 
262  PV_GENICAM_API bool IsPersistent() const;
263 
273  PV_GENICAM_API bool IsImplemented() const;
274 
280  PV_GENICAM_API bool IsAvailable() const;
281 
287  PV_GENICAM_API bool IsWritable() const;
288 
297  PV_GENICAM_API bool IsReadable() const;
298 
306  PV_GENICAM_API bool IsVisible( PvGenVisibility aCurrentVisibility ) const;
307 
316  PV_GENICAM_API bool IsStreamable() const;
317 
332  PV_GENICAM_API PvResult GetVisibility( PvGenVisibility &aVisibility ) const;
333 
349  PV_GENICAM_API PvResult IsVisible( PvGenVisibility aCurrentVisibility, bool &aVisible ) const;
350 
361  PV_GENICAM_API PvResult IsSelector( bool &aSelector ) const;
362 
375  PV_GENICAM_API PvResult GetSelectedParameters( PvGenParameterList &aList ) const;
376 
389  PV_GENICAM_API PvResult GetSelectingParameters( PvGenParameterList &aList ) const;
390 
405  PV_GENICAM_API PvResult RegisterEventSink( PvGenEventSink *aEventSink );
406 
418  PV_GENICAM_API PvResult UnregisterEventSink( PvGenEventSink *aEventSink );
419 
425  PV_GENICAM_API PvString ToString() const;
426 
439  PV_GENICAM_API PvResult ToString( PvString &aValue ) const;
440 
453  PV_GENICAM_API PvResult FromString( const PvString &aValue );
454 
466  PV_GENICAM_API PV_GENAPI_NS::INode *GetNode();
467 
473  PV_GENICAM_API bool GetUpdatesEnabled();
474 
480  PV_GENICAM_API void SetUpdatesEnabled( bool aEnabled );
481 
482 protected:
483 
487  PvGenParameter();
488 
492  virtual ~PvGenParameter();
493 
494 #ifndef PV_GENERATING_DOXYGEN_DOC
495 
496  PvGenICamLib::GenParameterInternal *mThis;
497 
498  friend class PvGenICamLib::GenParameterArray;
499  friend class PvGenICamLib::GenParameterArrayManager;
500 
501 #endif // PV_GENERATING_DOXYGEN_DOC
502 
503 private:
504 
505  // Not implemented
506  PvGenParameter( const PvGenParameter & );
507  const PvGenParameter &operator=( const PvGenParameter & );
508 
509 };
510 
517 class PvGenEventSink
518 {
519 public:
520 
528  virtual void OnParameterUpdate( PvGenParameter *aParameter ) = 0;
529 
530 };
531 
532 #endif
PvGenParameterList
Class used to hold a group of PvGenParameter pointers.
Definition: PvGenParameterList.h:58
PvGenVisibility
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:60
PvString
String class.
Definition: PvString.h:25
PvGenICamLib
Definition: PvGenCategory.h:15
PvResult
Result information.
Definition: PvResult.h:29
PvGenFloat
GenICam feature: Float.
Definition: PvGenFloat.h:20
PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:49
PvGenTypes.h
GenICam feature-related constants.
PvGenBoolean
GenICam feature: Boolean. A feature which can either be true or false.
Definition: PvGenBoolean.h:21
PvGenCommand
GenICam feature: Command. A feature which can only be activated.
Definition: PvGenCommand.h:19
PvGenEventSink
Observer interface for an observable PvGenParameter object.
Definition: PvGenParameter.h:517
PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:43
PvGenType
PvGenType
Feature data type (Boolean, integer, etc.)
Definition: PvGenTypes.h:108
PvGenInteger
GenICam feature: Integer.
Definition: PvGenInteger.h:20
PvGenString
GenICam feature: String.
Definition: PvGenString.h:20
PvGenRegister
GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device...
Definition: PvGenRegister.h:19

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