libiio
Public Member Functions | Properties | List of all members
iio.Buffer Class Reference
Inheritance diagram for iio.Buffer:
Inheritance graph
[legend]
Collaboration diagram for iio.Buffer:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, device, mask, idx=0)
 
def __del__ (self)
 
def cancel (self)
 
def device (self)
 
- Public Member Functions inherited from iio._IIO_Object
def __init__ (self, hdl, parent)
 
def __eq__ (self, other)
 

Properties

 enabled
 

Detailed Description

Represents a hardware I/O buffer.

Constructor & Destructor Documentation

◆ __init__()

def iio.Buffer.__init__ (   self,
  device,
  mask,
  idx = 0 
)
Initialize a new instance of the Buffer class.

:param device: type=iio.Device
    The iio.Device object that represents the device where the I/O
    operations will be performed
:param mask: type=ChannelsMask
    The mask of enabled channels
:param idx: type=int
    The hardware index of the buffer to use. If unsure, leave it to 0

returns: type=iio.Buffer
    An new instance of this class

◆ __del__()

def iio.Buffer.__del__ (   self)
Destroy this buffer.

Member Function Documentation

◆ cancel()

def iio.Buffer.cancel (   self)
Cancel the current buffer.

◆ device()

def iio.Buffer.device (   self)
Device for the buffer.
type: iio.Device

Property Documentation

◆ enabled

iio.Buffer.enabled
static
Initial value:
= property(
lambda self: self._enabled,
_set_enabled,
None,
"Represents the state (enabled/disabled) of the hardware buffer.",
)

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