Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvGenRegister Class Reference

GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device's register map. More...

Public Member Functions

PvResult Set (const uint8_t *aBuffer, int64_t aLength)
 Write to the register. More...
 
PvResult Get (uint8_t *aBuffer, int64_t aLength) const
 Reads from the register. More...
 
PvResult GetLength (int64_t &aLength) const
 Returns the length of the register mapped with this feature. 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

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

Detailed Description

GenICam feature: Register, or IRegister. A feature providing direct access to a section of the device's register map.

To use this class, see PvGenParameter.

Member Function Documentation

◆ Get()

PvResult PvGenRegister::Get ( uint8_t *  aBuffer,
int64_t  aLength 
) const

Reads from the register.

Partial (less than GetLength) reads are supported at the GenICam level, but the behaviour is defined by the device.

GigE Vision enforces a mod-4 (can be divided by 4 bytes) length restriction on all read/write operations.

Parameters
[out]aBufferData read from the register.
[out]aLengthLength of the buffer, in bytes.
Returns
See Set.

◆ GetLength()

PvResult PvGenRegister::GetLength ( int64_t &  aLength) const

Returns the length of the register mapped with this feature.

Parameters
[out]aLengthLength of the register, in bytes.
Returns
See Set.

◆ Set()

PvResult PvGenRegister::Set ( const uint8_t *  aBuffer,
int64_t  aLength 
)

Write to the register.

Partial (less than GetLength) writes are supported at the GenICam level, but the behaviour is defined by the device.

GigE Vision enforces a mod-4 (can be divided by 4 bytes) length restriction on all read/write operations.

Parameters
[in]aBufferData to write to the register.
[in]aLengthLength of the buffer, in bytes.
Returns
Includes:

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

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