Pleora Technologies Inc. eBUS SDK v6.5.1.6797 API



PvGenParameterArray.h
1 // *****************************************************************************
2 //
3 // Copyright (c) 2007, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENPARAMETERARRAY_H__
8 #define __PVGENPARAMETERARRAY_H__
9 
10 #include <PvGenICamLib.h>
11 #include <PvGenString.h>
12 #include <PvGenInteger.h>
13 #include <PvGenEnum.h>
14 #include <PvGenFloat.h>
15 #include <PvGenCommand.h>
16 #include <PvGenBoolean.h>
17 #include <PvGenRegister.h>
18 #include <PvGenCategory.h>
19 
20 
21 namespace PvGenICamLib
22 {
23  class GenParameterArray;
24  class GenParameterArrayManager;
25 }
26 
27 namespace PvDeviceLib
28 {
29  class Device;
30 }
31 
32 
33 class PvGenFile;
34 class PvConfigurationWriter;
35 class PvConfigurationReader;
36 
37 
72 class PvGenParameterArray
73 {
74 public:
75 
79  PV_GENICAM_API PvGenParameterArray();
80 
84  PV_GENICAM_API virtual ~PvGenParameterArray();
85 
92  PV_GENICAM_API uint32_t GetCount() const;
93 
102  PV_GENICAM_API PvGenParameter *Get( uint32_t aIndex );
103 
111  PV_GENICAM_API PvGenParameter *Get( const PvString &aName );
112 
121  PV_GENICAM_API PvGenParameter *operator[]( uint32_t aIndex );
122 
130  PV_GENICAM_API PvGenParameter *operator[]( const PvString &aName );
131 
137  PV_GENICAM_API uint32_t GetCategoryCount() const;
138 
147  PV_GENICAM_API PvGenCategory *GetCategory( uint32_t aIndex );
148 
156  PV_GENICAM_API PvGenCategory *GetCategory( const PvString &aName );
157 
166  PV_GENICAM_API PvResult InvalidateCache();
167 
179  PV_GENICAM_API PV_GENAPI_NS::INodeMap *GetNodeMap();
180 
191  PV_GENICAM_API PvGenInteger *GetInteger( const PvString &aName );
192 
203  PV_GENICAM_API PvGenFloat *GetFloat( const PvString &aName );
204 
215  PV_GENICAM_API PvGenEnum *GetEnum( const PvString &aName );
216 
227  PV_GENICAM_API PvGenBoolean *GetBoolean( const PvString &aName );
228 
239  PV_GENICAM_API PvGenCommand *GetCommand( const PvString &aName );
240 
251  PV_GENICAM_API PvGenString *GetString( const PvString &aName );
252 
263  PV_GENICAM_API PvGenRegister *GetRegister( const PvString &aName );
264 
277  PV_GENICAM_API PvResult GetIntegerValue( const PvString &aName, int64_t &aValue );
278 
291  PV_GENICAM_API PvResult SetIntegerValue( const PvString &aName, int64_t aValue );
292 
305  PV_GENICAM_API PvResult GetFloatValue( const PvString &aName, double &aValue );
306 
319  PV_GENICAM_API PvResult SetFloatValue( const PvString &aName, double aValue );
320 
333  PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, PvString &aValue );
334 
347  PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, int64_t &aValue );
348 
361  PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, const PvString &aValue );
362 
375  PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, int64_t aValue );
376 
389  PV_GENICAM_API PvResult GetBooleanValue( const PvString &aName, bool &aValue );
390 
403  PV_GENICAM_API PvResult SetBooleanValue( const PvString &aName, bool aValue );
404 
417  PV_GENICAM_API PvResult GetStringValue( const PvString &aName, PvString &aValue );
418 
431  PV_GENICAM_API PvResult SetStringValue( const PvString &aName, const PvString &aValue );
432 
444  PV_GENICAM_API PvResult ExecuteCommand( const PvString &aName );
445 
459  PV_GENICAM_API PvResult GetIntegerRange( const PvString &aName, int64_t &aMin, int64_t &aMax );
460 
474  PV_GENICAM_API PvResult GetFloatRange( const PvString &aName, double &aMin, double &aMax );
475 
496  PV_GENICAM_API PvResult AttachDataChunks( uint8_t *aBuffer, uint32_t aBufferLength );
497 
506  PV_GENICAM_API PvResult DetachDataChunks();
507 
517  PV_GENICAM_API PvGenAccessMode GetAccessMode() const;
518 
530  PV_GENICAM_API PvResult Poll();
531 
532 protected:
533 
534  PvGenICamLib::GenParameterArray *mThis;
535 
536 private:
537 
538  friend class PvGenFile;
539  friend class PvConfigurationWriter;
540  friend class PvConfigurationReader;
541  friend class PvGenICamLib::GenParameterArrayManager;
542  friend class PvDeviceLib::Device;
543 
544  // Not implemented
545  PvGenParameterArray( const PvGenParameterArray & );
546  const PvGenParameterArray &operator=( const PvGenParameterArray & );
547 
548 };
549 
550 #endif
PvString
String class.
Definition: PvString.h:25
PvGenICamLib
Definition: PvGenCategory.h:15
PvResult
Result information.
Definition: PvResult.h:29
PvGenCategory
GenICam category.
Definition: PvGenCategory.h:29
PvGenFloat
GenICam feature: Float.
Definition: PvGenFloat.h:20
PvGenFile
Allows reading/writing to files hosted on the device.
Definition: PvGenFile.h:37
PvConfigurationWriter
Save the state of the system.
Definition: PvConfigurationWriter.h:23
PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:49
PvDeviceLib
Definition: PvActionCommand.h:13
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
PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:43
PvGenParameterArray
GenICam feature array.
Definition: PvGenParameterArray.h:72
PvGenInteger
GenICam feature: Integer.
Definition: PvGenInteger.h:20
PvConfigurationReader
Restore the state of the system.
Definition: PvConfigurationReader.h:23
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