Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
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
21namespace PvGenICamLib
22{
23 class GenParameterArray;
24 class GenParameterArrayManager;
25}
26
27namespace PvDeviceLib
28{
29 class Device;
30}
31
32
33class PvGenFile;
34class PvConfigurationWriter;
35class PvConfigurationReader;
36
37
72class PvGenParameterArray
73{
74public:
75
79 PV_GENICAM_API PvGenParameterArray();
80
84 PV_GENICAM_API virtual ~PvGenParameterArray();
85
92 PV_GENICAM_API uint32_t GetCount() const;
93
101 PV_GENICAM_API PvGenParameter *Get( uint32_t aIndex );
102
110 PV_GENICAM_API PvGenParameter *Get( const PvString &aName );
111
119 PV_GENICAM_API PvGenParameter *operator[]( uint32_t aIndex );
120
128 PV_GENICAM_API PvGenParameter *operator[]( const PvString &aName );
129
135 PV_GENICAM_API uint32_t GetCategoryCount() const;
136
144 PV_GENICAM_API PvGenCategory *GetCategory( uint32_t aIndex );
145
153 PV_GENICAM_API PvGenCategory *GetCategory( const PvString &aName );
154
163 PV_GENICAM_API PvResult InvalidateCache();
164
176 PV_GENICAM_API PV_GENAPI_NS::INodeMap *GetNodeMap();
177
188 PV_GENICAM_API PvGenInteger *GetInteger( const PvString &aName );
189
200 PV_GENICAM_API PvGenFloat *GetFloat( const PvString &aName );
201
212 PV_GENICAM_API PvGenEnum *GetEnum( const PvString &aName );
213
224 PV_GENICAM_API PvGenBoolean *GetBoolean( const PvString &aName );
225
236 PV_GENICAM_API PvGenCommand *GetCommand( const PvString &aName );
237
248 PV_GENICAM_API PvGenString *GetString( const PvString &aName );
249
260 PV_GENICAM_API PvGenRegister *GetRegister( const PvString &aName );
261
274 PV_GENICAM_API PvResult GetIntegerValue( const PvString &aName, int64_t &aValue );
275
288 PV_GENICAM_API PvResult SetIntegerValue( const PvString &aName, int64_t aValue );
289
302 PV_GENICAM_API PvResult GetFloatValue( const PvString &aName, double &aValue );
303
316 PV_GENICAM_API PvResult SetFloatValue( const PvString &aName, double aValue );
317
330 PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, PvString &aValue );
331
344 PV_GENICAM_API PvResult GetEnumValue( const PvString &aName, int64_t &aValue );
345
358 PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, const PvString &aValue );
359
372 PV_GENICAM_API PvResult SetEnumValue( const PvString &aName, int64_t aValue );
373
386 PV_GENICAM_API PvResult GetBooleanValue( const PvString &aName, bool &aValue );
387
400 PV_GENICAM_API PvResult SetBooleanValue( const PvString &aName, bool aValue );
401
414 PV_GENICAM_API PvResult GetStringValue( const PvString &aName, PvString &aValue );
415
428 PV_GENICAM_API PvResult SetStringValue( const PvString &aName, const PvString &aValue );
429
441 PV_GENICAM_API PvResult ExecuteCommand( const PvString &aName );
442
456 PV_GENICAM_API PvResult GetIntegerRange( const PvString &aName, int64_t &aMin, int64_t &aMax );
457
471 PV_GENICAM_API PvResult GetFloatRange( const PvString &aName, double &aMin, double &aMax );
472
493 PV_GENICAM_API PvResult AttachDataChunks( uint8_t *aBuffer, uint32_t aBufferLength );
494
503 PV_GENICAM_API PvResult DetachDataChunks();
504
514 PV_GENICAM_API PvGenAccessMode GetAccessMode() const;
515
527 PV_GENICAM_API PvResult Poll();
528
529protected:
530
531 PvGenICamLib::GenParameterArray *mThis;
532
533private:
534
535 friend class PvGenFile;
536 friend class PvConfigurationWriter;
537 friend class PvConfigurationReader;
538 friend class PvGenICamLib::GenParameterArrayManager;
539 friend class PvDeviceLib::Device;
540
541 // Not implemented
542 PvGenParameterArray( const PvGenParameterArray & );
543 const PvGenParameterArray &operator=( const PvGenParameterArray & );
544
545};
546
547#endif
PvGenAccessMode
PvGenAccessMode
Definition PvGenTypes.h:159
PvConfigurationReader
Reads and restores configuration data from persistence files.
Definition PvConfigurationReader.h:29
PvConfigurationWriter
Writes configuration data to persistence files.
Definition PvConfigurationWriter.h:29
PvGenBoolean
GenICam feature: Boolean. A feature which can either be true or false.
Definition PvGenBoolean.h:22
PvGenCategory
GenICam category.
Definition PvGenCategory.h:30
PvGenCommand
GenICam feature: Command. A feature which can only be activated.
Definition PvGenCommand.h:20
PvGenEnum
GenICam feature: Enumeration. A feature which can take one of many defined values.
Definition PvGenEnum.h:42
PvGenFile
Allows reading/writing to files hosted on the device.
Definition PvGenFile.h:41
PvGenFloat
GenICam feature: Float.
Definition PvGenFloat.h:21
PvGenInteger
GenICam feature: Integer.
Definition PvGenInteger.h:21
PvGenParameterArray
GenICam feature array.
Definition PvGenParameterArray.h:73
PvGenParameterArray::GetEnum
PvGenEnum * GetEnum(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenEnum.
Definition PvGenParameterArray.cpp:255
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:588
PvGenParameterArray::GetBoolean
PvGenBoolean * GetBoolean(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenBoolean.
Definition PvGenParameterArray.cpp:279
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:654
PvGenParameterArray::DetachDataChunks
PvResult DetachDataChunks()
Detach previously attached data chunks.
Definition PvGenParameterArray.cpp:743
PvGenParameterArray::GetAccessMode
PvGenAccessMode GetAccessMode() const
Returns the access mode of the port of the GenICam node map.
Definition PvGenParameterArray.cpp:766
PvGenParameterArray::Poll
PvResult Poll()
Invalidates nodes having reach their defined polling time since last update.
Definition PvGenParameterArray.cpp:792
PvGenParameterArray::GetCommand
PvGenCommand * GetCommand(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenCommand.
Definition PvGenParameterArray.cpp:308
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:468
PvGenParameterArray::GetCategory
PvGenCategory * GetCategory(uint32_t aIndex)
Get a category (PvGenCategory object) from the array (using array position).
Definition PvGenParameterArray.cpp:136
PvGenParameterArray::PvGenParameterArray
PvGenParameterArray()
Constructor.
Definition PvGenParameterArray.cpp:33
PvGenParameterArray::GetCount
uint32_t GetCount() const
Get the number of parameters (PvGenParameter objects) in the array.
Definition PvGenParameterArray.cpp:58
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:408
PvGenParameterArray::Get
PvGenParameter * Get(uint32_t aIndex)
Get a parameter (PvGenParameter object) from the array (using array position).
Definition PvGenParameterArray.cpp:70
PvGenParameterArray::GetCategoryCount
uint32_t GetCategoryCount() const
Get the number of categories (PvGenCategory objects) in the array.
Definition PvGenParameterArray.cpp:124
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:548
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:380
PvGenParameterArray::GetRegister
PvGenRegister * GetRegister(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenRegister.
Definition PvGenParameterArray.cpp:356
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:428
PvGenParameterArray::GetString
PvGenString * GetString(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenString.
Definition PvGenParameterArray.cpp:332
PvGenParameterArray::InvalidateCache
PvResult InvalidateCache()
Invalidates the cache of the GenICam parameter array.
Definition PvGenParameterArray.cpp:171
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:508
PvGenParameterArray::GetFloat
PvGenFloat * GetFloat(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenFloat.
Definition PvGenParameterArray.cpp:231
PvGenParameterArray::GetNodeMap
PV_GENAPI_NS::INodeMap * GetNodeMap()
Returns the interface of the GenApi node map wrapped by this PvGenParameterArray.
Definition PvGenParameterArray.cpp:195
PvGenParameterArray::AttachDataChunks
PvResult AttachDataChunks(uint8_t *aBuffer, uint32_t aBufferLength)
Attaches a payload containing data chunks to a GenICam node map.
Definition PvGenParameterArray.cpp:700
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:608
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:628
PvGenParameterArray::~PvGenParameterArray
virtual ~PvGenParameterArray()
Destructor.
Definition PvGenParameterArray.cpp:44
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:568
PvGenParameterArray::ExecuteCommand
PvResult ExecuteCommand(const PvString &aName)
Helper method used to directly execute a command parameter of this parameter array.
Definition PvGenParameterArray.cpp:680
PvGenParameterArray::operator[]
PvGenParameter * operator[](uint32_t aIndex)
Get a parameter (PvGenParameter object) from the array (using array position).
Definition PvGenParameterArray.cpp:104
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:448
PvGenParameterArray::GetInteger
PvGenInteger * GetInteger(const PvString &aName)
Helper method returning a PvGenParameter casted as a PvGenInteger.
Definition PvGenParameterArray.cpp:207
PvGenParameter
Base class for all GenICam feature types.
Definition PvGenParameter.h:44
PvGenRegister
GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device...
Definition PvGenRegister.h:20
PvGenString
GenICam feature: String.
Definition PvGenString.h:21
PvResult
Result information.
Definition PvResult.h:30
PvString
String class.
Definition PvString.h:26

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