eBUS SDK v6.2.8.5877 API
7 #ifndef __PVGENPARAMETER_H__
8 #define __PVGENPARAMETER_H__
10 #include <PvGenICamLib.h>
11 #include <PvGenParameterList.h>
19 namespace PvGenICamLib
21 class GenParameterArray;
22 class GenParameterInternal;
23 class GenParameterArrayManager;
27 #ifdef PV_INTERNAL_HEADERS
35 #endif // PV_INTERNAL_HEADERS
41 #ifndef EBUS_PYTHON_DOXYGEN
82 PV_GENICAM_API PV_GENAPI_NS::INode *
GetNode();
117 PV_GENAPI_NS::INode *
GetNode();
128 #ifndef PV_GENERATING_DOXYGEN_DOC
130 PvGenICamLib::GenParameterInternal *mThis;
132 friend class PvGenICamLib::GenParameterArray;
133 friend class PvGenICamLib::GenParameterArrayManager;
135 #endif // PV_GENERATING_DOXYGEN_DOC
bool IsPersistent() const
Test if the parameter is to be considered when saving the state of a GenICam interface to disk.
Definition: PvGenParameter.cpp:536
Result information.
Definition: PvResult.h:13
GenApi_3_3 ::INode * GetNode()
Returns the GenApi node wrapped by this PvGenParameter.
Definition: PvGenParameter.cpp:1420
bool IsStreamable() const
Test if the parameter is streamable.
Definition: PvGenParameter.cpp:846
GenICam feature: Float.
Definition: PvGenFloat.h:13
GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device...
Definition: PvGenRegister.h:13
bool IsValueCached() const
Test if the parameter's value is cached in the PC.
Definition: PvGenParameter.cpp:464
PvResult GetCategory(PvString &aCategory) const
Get the parameter's category.
Definition: PvGenParameter.cpp:198
PvResult GetDisplayName(PvString &aDisplayName) const
Get the parameter's display name.
Definition: PvGenParameter.cpp:333
PvResult RegisterEventSink(PvGenEventSink *aEventSink)
Register an event sink interface that will be used for callbacks on this parameter.
Definition: PvGenParameter.cpp:1194
String class.
Definition: PvString.h:21
PvResult GetToolTip(PvString &aToolTip) const
Get the parameter's tool tip.
Definition: PvGenParameter.cpp:239
PvGenParameter()
Constructor.
Definition: PvGenParameter.cpp:34
PvResult GetNameSpace(PvGenNameSpace &aNameSpace) const
Get the parameter's name space.
Definition: PvGenParameter.cpp:377
PvResult GetSelectingParameters(PvGenParameterList &aList) const
Returns all selectors for this parameter.
Definition: PvGenParameter.cpp:1132
PvResult GetVisibility(PvGenVisibility &aVisibility) const
Get the parameter's recommended user level (visibility)
Definition: PvGenParameter.cpp:882
bool GetUpdatesEnabled()
Returns true if parameter update notifications are temporarily disabled.
Definition: PvGenParameter.cpp:1388
Class used to hold a group of PvGenParameter pointers.
Definition: PvGenParameterList.h:23
bool IsReadable() const
Test if the parameter is readable.
Definition: PvGenParameter.cpp:781
virtual void OnParameterUpdate(PvGenParameter *aParameter)=0
Callback that is invoked when a feature's value is updated.
Observer interface for an observable PvGenParameter object.
Definition: PvGenParameter.h:146
GenICam feature: Command. A feature which can only be activated.
Definition: PvGenCommand.h:13
bool IsImplemented() const
Test if the parameter is implemented.
Definition: PvGenParameter.cpp:604
GenICam feature-related constants.
PvResult UnregisterEventSink(PvGenEventSink *aEventSink)
Unregister an event sink.
Definition: PvGenParameter.cpp:1241
PvResult FromString(const PvString &aValue)
Sets the parameter value from a string.
Definition: PvGenParameter.cpp:1360
GenICam feature: Boolean. A feature which can either be true or false.
Definition: PvGenBoolean.h:13
PvResult IsSelector(bool &aSelector) const
Queries whether this parameter is a selector or not.
Definition: PvGenParameter.cpp:1033
GenICam feature: String.
Definition: PvGenString.h:13
PvResult GetDescription(PvString &aDescription) const
Get the parameter's description.
Definition: PvGenParameter.cpp:285
virtual ~PvGenParameter()
Destructor.
Definition: PvGenParameter.cpp:40
PvString GetName() const
Get the parameter's name.
Definition: PvGenParameter.cpp:57
PvGenType
Feature data type (Boolean, integer, etc.)
Definition: PvGenTypes.h:22
PvResult GetType(PvGenType &aType) const
Get the parameter's type.
Definition: PvGenParameter.cpp:124
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
PvResult GetSelectedParameters(PvGenParameterList &aList) const
Returns all parameters selected by this parameter.
Definition: PvGenParameter.cpp:1080
GenICam feature: Integer.
Definition: PvGenInteger.h:13
void SetUpdatesEnabled(bool aEnabled)
Temporarily disable (or re-enable) parameter update notifications.
Definition: PvGenParameter.cpp:1400
bool IsVisible(PvGenVisibility aCurrentVisibility) const
Test if the parameter is visible at the specified visibilty level.
Definition: PvGenParameter.cpp:1005
bool IsAvailable() const
Test if the parameter is currently available, but may be available latter on.
Definition: PvGenParameter.cpp:660
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:11
PvString ToString() const
Gets the parameter value as a string.
Definition: PvGenParameter.cpp:1279
bool IsWritable() const
Test if the parameter is writable.
Definition: PvGenParameter.cpp:716
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com