Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenInteger Class Reference

GenICam feature: Integer. More...

Public Member Functions

PvResult SetValue (int64_t aValue)
 Set the feature's new value. More...
 
PvResult GetValue (int64_t &aValue) const
 Get the feature's value. More...
 
PvResult GetMin (int64_t &aMin) const
 Get the feature's limits (minimum). More...
 
PvResult GetMax (int64_t &aMax) const
 Get the feature's limits (maximum). More...
 
PvResult GetIncrement (int64_t &aIncrement) const
 Get the feature's suggested increment. More...
 
PvResult GetRepresentation (PvGenRepresentation &aRepresentation) const
 Get the feature's suggested presentation format. More...
 
PvResult GetUnit (PvString &aUnit) const
 Get the feature's measurement unit. More...
 
- Public Member Functions inherited from PvGenParameter
PvString GetName () const
 Get the parameter's name. More...
 
PvResult GetName (PvString &aName) const
 Get the parameter's name. More...
 
PvResult GetType (PvGenType &aType) const
 Get the parameter's type. More...
 
PvResult GetCategory (PvString &aCategory) const
 Get the parameter's category. More...
 
PvResult GetToolTip (PvString &aToolTip) const
 Get the parameter's tool tip. More...
 
PvResult GetDescription (PvString &aDescription) const
 Get the parameter's description. More...
 
PvResult GetDisplayName (PvString &aDisplayName) const
 Get the parameter's display name. More...
 
PvResult GetNameSpace (PvGenNameSpace &aNameSpace) const
 Get the parameter's name space. More...
 
PvResult IsValueCached (bool &aCached) const
 Test if the parameter's value is cached in the PC. More...
 
PvResult IsPersistent (bool &aPersistent) const
 Test if the parameter is to be considered when saving the state of a GenICam interface to disk. More...
 
PvResult IsImplemented (bool &aImplemented) const
 Test if the parameter is implemented. More...
 
PvResult IsAvailable (bool &aAvailable) const
 Test if the parameter is currently available, but may be available latter on. More...
 
PvResult IsWritable (bool &aWritable) const
 Test if the parameter is writable. More...
 
PvResult IsReadable (bool &aReadable) const
 Test if the parameter is readable. More...
 
PvResult IsStreamable (bool &aStreamable) const
 Test if the parameter is streamable. More...
 
bool IsValueCached () const
 Test if the parameter's value is cached in the PC. More...
 
bool IsPersistent () const
 Test if the parameter is to be considered when saving the state of a GenICam interface to disk. More...
 
bool IsImplemented () const
 Test if the parameter is implemented. More...
 
bool IsAvailable () const
 Test if the parameter is currently available, but may be available latter on. More...
 
bool IsWritable () const
 Test if the parameter is writable. More...
 
bool IsReadable () const
 Test if the parameter is readable. More...
 
bool IsVisible (PvGenVisibility aCurrentVisibility) const
 Test if the parameter is visible at the specified visibilty level. More...
 
bool IsStreamable () const
 Test if the parameter is streamable. More...
 
PvResult GetVisibility (PvGenVisibility &aVisibility) const
 Get the parameter's recommended user level (visibility) More...
 
PvResult IsVisible (PvGenVisibility aCurrentVisibility, bool &aVisible) const
 Test if the parameter is visible at the specified visibilty level. More...
 
PvResult IsSelector (bool &aSelector) const
 Queries whether this parameter is a selector or not. More...
 
PvResult GetSelectedParameters (PvGenParameterList &aList) const
 Returns all parameters selected by this parameter. More...
 
PvResult GetSelectingParameters (PvGenParameterList &aList) const
 Returns all selectors for this parameter. More...
 
PvResult RegisterEventSink (PvGenEventSink *aEventSink)
 Register an event sink interface that will be used for callbacks on this parameter. More...
 
PvResult UnregisterEventSink (PvGenEventSink *aEventSink)
 Unregister an event sink. More...
 
PvString ToString () const
 Gets the parameter value as a string. More...
 
PvResult ToString (PvString &aValue) const
 Gets the parameter value as a string. More...
 
PvResult FromString (const PvString &aValue)
 Sets the parameter value from a string. More...
 
GenApi_3_3::INode * GetNode ()
 Returns the GenApi node wrapped by this PvGenParameter. More...
 
bool GetUpdatesEnabled ()
 Returns true if parameter update notifications are temporarily disabled. More...
 
void SetUpdatesEnabled (bool aEnabled)
 Temporarily disable (or re-enable) parameter update notifications. More...
 

Protected Member Functions

 PvGenInteger ()
 Constructor.
 
virtual ~PvGenInteger ()
 Destructor.
 
- Protected Member Functions inherited from PvGenParameter
 PvGenParameter ()
 Constructor.
 
virtual ~PvGenParameter ()
 Destructor.
 

Detailed Description

GenICam feature: Integer.

To use this class, see PvGenParameter.

Member Function Documentation

PvResult PvGenInteger::GetIncrement ( int64_t &  aIncrement) const

Get the feature's suggested increment.

The GetIncrement method suggests how much an up/down button in the UI should increment/decrement the current value.

For example, a feature with a range of 0 to 1000000 might have an increment of 100000 to keep the user from having to click excessively.

Parameters
[out]aIncrementThe feature's suggested increment.
Returns
See SetValue.
PvResult PvGenInteger::GetMax ( int64_t &  aMax) const

Get the feature's limits (maximum).

Parameters
[out]aMaxThe feature's maximum allowable value.
Returns
See SetValue.
PvResult PvGenInteger::GetMin ( int64_t &  aMin) const

Get the feature's limits (minimum).

Parameters
[out]aMinThe feature's minimum allowable value.
Returns
See SetValue.
PvResult PvGenInteger::GetRepresentation ( PvGenRepresentation aRepresentation) const

Get the feature's suggested presentation format.

See PvGenFloat::GetRepresentation.

Parameters
[out]aRepresentationSee PvGenFloat::GetRepresentation.
Returns
See SetValue.
PvResult PvGenInteger::GetUnit ( PvString aUnit) const

Get the feature's measurement unit.

The GetUnit method returns a string with the units for the feature. For example, the string might contain "pixels", "bytes", "ms", and so on. The string is informational and has no intrinsic value for converting to other units.

Parameters
[out]aUnitThe units for the feature.
Returns
See SetValue.
PvResult PvGenInteger::GetValue ( int64_t &  aValue) const

Get the feature's value.

Parameters
[out]aValueThe feature's value.
Returns
See SetValue.
PvResult PvGenInteger::SetValue ( int64_t  aValue)

Set the feature's new value.

Parameters
[in]aValueThe feature's new value.
Returns
Includes:

The documentation for this class was generated from the following files:

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