eBUS SDK v6.2.8.5877 API
7 #ifndef __PVGENPARAMETERARRAY_H__
8 #define __PVGENPARAMETERARRAY_H__
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>
21 namespace PvGenICamLib
23 class GenParameterArray;
24 class GenParameterArrayManager;
45 PV_GENICAM_API uint32_t
GetCount()
const;
58 PV_GENICAM_API PV_GENAPI_NS::INodeMap *
GetNodeMap();
69 #ifndef EBUS_PYTHON_DOXYGEN
98 int64_t GetEnumValueInt(
const PvString &aName );
118 PvGenICamLib::GenParameterArray *mThis;
125 friend class PvGenICamLib::GenParameterArrayManager;
126 friend class PvDeviceLib::Device;
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
Result information.
Definition: PvResult.h:13
GenICam feature: Float.
Definition: PvGenFloat.h:13
PvResult DetachDataChunks()
Detach previously attached data chunks.
Definition: PvGenParameterArray.cpp:1051
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
PvGenRegister * GetRegister(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenRegister.
Definition: PvGenParameterArray.cpp:478
GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device...
Definition: PvGenRegister.h:13
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
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
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
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
Save the state of the system.
Definition: PvConfigurationWriter.h:23
PvResult ExecuteCommand(const PvString &aName)
Helper method used to directly execute a command parameter of this parameter array.
Definition: PvGenParameterArray.cpp:964
PvGenParameter * Get(uint32_t aIndex)
Get a parameter (PvGenParameter object) from the array (using array position).
Definition: PvGenParameterArray.cpp:107
PvGenEnum * GetEnum(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenEnum.
Definition: PvGenParameterArray.cpp:349
PvGenBoolean * GetBoolean(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenBoolean.
Definition: PvGenParameterArray.cpp:380
PvGenAccessMode GetAccessMode() const
Returns the access mode of the port of the GenICam node map.
Definition: PvGenParameterArray.cpp:1079
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
PvResult AttachDataChunks(uint8_t *aBuffer, uint32_t aBufferLength)
Attaches a payload containing data chunks to a GenICam node map.
Definition: PvGenParameterArray.cpp:1004
PvGenCategory * GetCategory(uint32_t aIndex)
Get a category (PvGenCategory object) from the array (using array position).
Definition: PvGenParameterArray.cpp:193
String class.
Definition: PvString.h:21
PvGenString * GetString(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenString.
Definition: PvGenParameterArray.cpp:447
GenICam feature array.
Definition: PvGenParameterArray.h:38
PvResult Poll()
Invalidates nodes having reach their defined polling time since last update.
Definition: PvGenParameterArray.cpp:1112
PvGenInteger * GetInteger(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenInteger.
Definition: PvGenParameterArray.cpp:287
virtual ~PvGenParameterArray()
Destructor.
Definition: PvGenParameterArray.cpp:75
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
GenICam feature: Command. A feature which can only be activated.
Definition: PvGenCommand.h:13
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
PvGenParameter * operator[](uint32_t aIndex)
Get a parameter (PvGenParameter object) from the array (using array position).
Definition: PvGenParameterArray.cpp:150
GenICam feature: Boolean. A feature which can either be true or false.
Definition: PvGenBoolean.h:13
PvGenCommand * GetCommand(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenCommand.
Definition: PvGenParameterArray.cpp:416
Restore the state of the system.
Definition: PvConfigurationReader.h:23
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
GenICam feature: String.
Definition: PvGenString.h:13
uint32_t GetCount() const
Get the number of parameters (PvGenParameter objects) in the array.
Definition: PvGenParameterArray.cpp:91
PvResult InvalidateCache()
Invalidates the cache of the GenICam parameter array.
Definition: PvGenParameterArray.cpp:236
Allows reading/writing to files hosted on the device.
Definition: PvGenFile.h:29
PvGenFloat * GetFloat(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenFloat.
Definition: PvGenParameterArray.cpp:318
Base class for all GenICam feature types.
Definition: PvGenParameter.h:37
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition: PvGenEnum.h:14
PvGenParameterArray()
Constructor.
Definition: PvGenParameterArray.cpp:64
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
GenICam feature: Integer.
Definition: PvGenInteger.h:13
GenICam category.
Definition: PvGenCategory.h:23
GenApi_3_3 ::INodeMap * GetNodeMap()
Returns the interface of the GenApi node map wrapped by this PvGenParameterArray.
Definition: PvGenParameterArray.cpp:268
uint32_t GetCategoryCount() const
Get the number of categories (PvGenCategory objects) in the array.
Definition: PvGenParameterArray.cpp:176
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