Pleora Technologies Inc. eBUS SDK v6.2.8.5877 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;
36 
37 
39 {
40 public:
41 
42  PV_GENICAM_API PvGenParameterArray();
43  PV_GENICAM_API virtual ~PvGenParameterArray();
44 
45  PV_GENICAM_API uint32_t GetCount() const;
46  PV_GENICAM_API PvGenParameter *Get( uint32_t aIndex );
47  PV_GENICAM_API PvGenParameter *Get( const PvString &aName );
48 
49  PV_GENICAM_API PvGenParameter *operator[]( uint32_t aIndex );
50  PV_GENICAM_API PvGenParameter *operator[]( const PvString &aName );
51 
52  PV_GENICAM_API uint32_t GetCategoryCount() const;
53  PV_GENICAM_API PvGenCategory *GetCategory( uint32_t aIndex );
54  PV_GENICAM_API PvGenCategory *GetCategory( const PvString &aName );
55 
56  PV_GENICAM_API PvResult InvalidateCache();
57 
58  PV_GENICAM_API PV_GENAPI_NS::INodeMap *GetNodeMap();
59 
60  // Helper methods for direct feature access. Returns NULL on type mismatch.
61  PV_GENICAM_API PvGenInteger *GetInteger( const PvString &aName );
62  PV_GENICAM_API PvGenFloat *GetFloat( const PvString &aName );
63  PV_GENICAM_API PvGenEnum *GetEnum( const PvString &aName );
64  PV_GENICAM_API PvGenBoolean *GetBoolean( const PvString &aName );
65  PV_GENICAM_API PvGenCommand *GetCommand( const PvString &aName );
66  PV_GENICAM_API PvGenString *GetString( const PvString &aName );
67  PV_GENICAM_API PvGenRegister *GetRegister( const PvString &aName );
68 
69 #ifndef EBUS_PYTHON_DOXYGEN
70  // Helper methods for direct feature get/set
71  PV_GENICAM_API PvResult GetIntegerValue( const PvString &aName, int64_t &aValue );
72  PV_GENICAM_API PvResult SetIntegerValue( const PvString &aName, int64_t aValue );
73  PV_GENICAM_API PvResult GetFloatValue( const PvString &aName, double &aValue );
74  PV_GENICAM_API PvResult SetFloatValue( const PvString &aName, double aValue );
75  PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, PvString &aValue );
76  PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, int64_t &aValue );
77  PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, const PvString &aValue );
78  PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, int64_t aValue );
79  PV_GENICAM_API PvResult GetBooleanValue( const PvString &aName, bool &aValue );
80  PV_GENICAM_API PvResult SetBooleanValue( const PvString &aName, bool aValue );
81  PV_GENICAM_API PvResult GetStringValue( const PvString &aName, PvString &aValue );
82  PV_GENICAM_API PvResult SetStringValue( const PvString &aName, const PvString &aValue );
83  PV_GENICAM_API PvResult ExecuteCommand( const PvString &aName );
84 
85  // Range accessors
86  PV_GENICAM_API PvResult GetIntegerRange( const PvString &aName, int64_t &aMin, int64_t &aMax );
87  PV_GENICAM_API PvResult GetFloatRange( const PvString &aName, double &aMin, double &aMax );
88 
89  // Chunks
90  PV_GENICAM_API PvResult AttachDataChunks( uint8_t *aBuffer, uint32_t aBufferLength );
91  PV_GENICAM_API PvResult DetachDataChunks();
92 #else
93  int64_t GetIntegerValue( const PvString &aName );
94  PvResult SetIntegerValue( const PvString &aName, int64_t aValue );
95  double GetFloatValue( const PvString &aName );
96  PvResult SetFloatValue( const PvString &aName, double aValue );
97  PvString GetEnumValueString( const PvString &aName );
98  int64_t GetEnumValueInt( const PvString &aName );
99  PvResult SetEnumValue( const PvString &aName, const PvString &aValue );
100  PvResult SetEnumValue( const PvString &aName, int64_t aValue );
101  bool GetBooleanValue( const PvString &aName );
102  PvResult SetBooleanValue( const PvString &aName, bool aValue );
103  PvString GetStringValue( const PvString &aName );
104  PvResult SetStringValue( const PvString &aName, const PvString &aValue );
105  PvResult ExecuteCommand( const PvString &aName );
106  tuple GetIntegerRange( const PvString &aName );
107  tuple GetFloatRange( const PvString &aName );
108  PvResult AttachDataChunks( bytes aBuffer );
110 #endif
111 
112  PV_GENICAM_API PvGenAccessMode GetAccessMode() const;
113 
114  PV_GENICAM_API PvResult Poll();
115 
116 protected:
117 
118  PvGenICamLib::GenParameterArray *mThis;
119 
120 private:
121 
122  friend class PvGenFile;
123  friend class PvConfigurationWriter;
124  friend class PvConfigurationReader;
125  friend class PvGenICamLib::GenParameterArrayManager;
126  friend class PvDeviceLib::Device;
127 
128  // Not implemented
130  const PvGenParameterArray &operator=( const PvGenParameterArray & );
131 
132 };
133 
134 #endif
PvGenParameterArray::SetFloatValue
PvResult SetFloatValue(const PvString &aName, double aValue)
Helper method used to directly write a float parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:604
PvResult
Result information.
Definition: PvResult.h:13
PvGenFloat
GenICam feature: Float.
Definition: PvGenFloat.h:13
PvGenParameterArray::DetachDataChunks
PvResult DetachDataChunks()
Detach previously attached data chunks.
Definition: PvGenParameterArray.cpp:1051
PvGenParameterArray::GetIntegerValue
PvResult GetIntegerValue(const PvString &aName, int64_t &aValue)
Helper method used to directly read an integer parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:515
PvGenParameterArray::GetRegister
PvGenRegister * GetRegister(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenRegister.
Definition: PvGenParameterArray.cpp:478
PvGenRegister
GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device...
Definition: PvGenRegister.h:13
PvGenParameterArray::GetIntegerRange
PvResult GetIntegerRange(const PvString &aName, int64_t &aMin, int64_t &aMax)
Helper method used to directly retrieve the range of an integer parameter.
Definition: PvGenParameterArray.cpp:891
PvGenParameterArray::SetStringValue
PvResult SetStringValue(const PvString &aName, const PvString &aValue)
Helper method used to directly write a string parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:857
PvGenParameterArray::GetFloatRange
PvResult GetFloatRange(const PvString &aName, double &aMin, double &aMax)
Helper method used to directly retrieve the range of a float parameter.
Definition: PvGenParameterArray.cpp:931
PvGenParameterArray::SetBooleanValue
PvResult SetBooleanValue(const PvString &aName, bool aValue)
Helper method used to directly write a boolean parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:796
PvConfigurationWriter
Save the state of the system.
Definition: PvConfigurationWriter.h:23
PvGenParameterArray::ExecuteCommand
PvResult ExecuteCommand(const PvString &aName)
Helper method used to directly execute a command parameter of this parameter array.
Definition: PvGenParameterArray.cpp:964
PvGenParameterArray::Get
PvGenParameter * Get(uint32_t aIndex)
Get a parameter (PvGenParameter object) from the array (using array position).
Definition: PvGenParameterArray.cpp:107
PvGenParameterArray::GetEnum
PvGenEnum * GetEnum(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenEnum.
Definition: PvGenParameterArray.cpp:349
PvGenParameterArray::GetBoolean
PvGenBoolean * GetBoolean(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenBoolean.
Definition: PvGenParameterArray.cpp:380
PvGenParameterArray::GetAccessMode
PvGenAccessMode GetAccessMode() const
Returns the access mode of the port of the GenICam node map.
Definition: PvGenParameterArray.cpp:1079
PvGenParameterArray::SetEnumValue
PvResult SetEnumValue(const PvString &aName, const PvString &aValue)
Helper method used to directly write an enumeration parameter value (as a string) of this parameter a...
Definition: PvGenParameterArray.cpp:707
PvGenParameterArray::AttachDataChunks
PvResult AttachDataChunks(uint8_t *aBuffer, uint32_t aBufferLength)
Attaches a payload containing data chunks to a GenICam node map.
Definition: PvGenParameterArray.cpp:1004
PvGenParameterArray::GetCategory
PvGenCategory * GetCategory(uint32_t aIndex)
Get a category (PvGenCategory object) from the array (using array position).
Definition: PvGenParameterArray.cpp:193
PvString
String class.
Definition: PvString.h:21
PvGenParameterArray::GetString
PvGenString * GetString(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenString.
Definition: PvGenParameterArray.cpp:447
PvGenParameterArray
GenICam feature array.
Definition: PvGenParameterArray.h:38
PvGenParameterArray::Poll
PvResult Poll()
Invalidates nodes having reach their defined polling time since last update.
Definition: PvGenParameterArray.cpp:1112
PvGenParameterArray::GetInteger
PvGenInteger * GetInteger(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenInteger.
Definition: PvGenParameterArray.cpp:287
PvGenParameterArray::~PvGenParameterArray
virtual ~PvGenParameterArray()
Destructor.
Definition: PvGenParameterArray.cpp:75
PvGenParameterArray::SetIntegerValue
PvResult SetIntegerValue(const PvString &aName, int64_t aValue)
Helper method used to directly write an integer parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:543
PvGenCommand
GenICam feature: Command. A feature which can only be activated.
Definition: PvGenCommand.h:13
PvGenParameterArray::GetFloatValue
PvResult GetFloatValue(const PvString &aName, double &aValue)
Helper method used to directly read a float parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:576
PvGenParameterArray::operator[]
PvGenParameter * operator[](uint32_t aIndex)
Get a parameter (PvGenParameter object) from the array (using array position).
Definition: PvGenParameterArray.cpp:150
PvGenBoolean
GenICam feature: Boolean. A feature which can either be true or false.
Definition: PvGenBoolean.h:13
PvGenParameterArray::GetCommand
PvGenCommand * GetCommand(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenCommand.
Definition: PvGenParameterArray.cpp:416
PvConfigurationReader
Restore the state of the system.
Definition: PvConfigurationReader.h:23
PvGenParameterArray::GetBooleanValue
PvResult GetBooleanValue(const PvString &aName, bool &aValue)
Helper method used to directly read a boolean parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:768
PvGenString
GenICam feature: String.
Definition: PvGenString.h:13
PvGenParameterArray::GetCount
uint32_t GetCount() const
Get the number of parameters (PvGenParameter objects) in the array.
Definition: PvGenParameterArray.cpp:91
PvGenParameterArray::InvalidateCache
PvResult InvalidateCache()
Invalidates the cache of the GenICam parameter array.
Definition: PvGenParameterArray.cpp:236
PvGenFile
Allows reading/writing to files hosted on the device.
Definition: PvGenFile.h:29
PvGenParameterArray::GetFloat
PvGenFloat * GetFloat(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenFloat.
Definition: PvGenParameterArray.cpp:318
PvGenParameter
Base class for all GenICam feature types.
Definition: PvGenParameter.h:37
PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:14
PvGenParameterArray::PvGenParameterArray
PvGenParameterArray()
Constructor.
Definition: PvGenParameterArray.cpp:64
PvGenParameterArray::GetStringValue
PvResult GetStringValue(const PvString &aName, PvString &aValue)
Helper method used to directly read a string parameter value of this parameter array.
Definition: PvGenParameterArray.cpp:829
PvGenInteger
GenICam feature: Integer.
Definition: PvGenInteger.h:13
PvGenCategory
GenICam category.
Definition: PvGenCategory.h:23
PvGenParameterArray::GetNodeMap
GenApi_3_3 ::INodeMap * GetNodeMap()
Returns the interface of the GenApi node map wrapped by this PvGenParameterArray.
Definition: PvGenParameterArray.cpp:268
PvGenParameterArray::GetCategoryCount
uint32_t GetCategoryCount() const
Get the number of categories (PvGenCategory objects) in the array.
Definition: PvGenParameterArray.cpp:176
PvGenParameterArray::GetEnumValue
PvResult GetEnumValue(const PvString &aName, PvString &aValue)
Helper method used to directly read an enumeration parameter value (as a string) of this parameter ar...
Definition: PvGenParameterArray.cpp:650

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