libiio
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
iio.IOBuffer Class Reference

iio.IOBuffer class: The class used for all I/O operations. More...

Inheritance diagram for iio.IOBuffer:
Inheritance graph
[legend]
Collaboration diagram for iio.IOBuffer:
Collaboration graph
[legend]

Public Member Functions

 IOBuffer (Device dev, ChannelsMask mask, uint index=0)
 Initializes a new instance of the iio.IOBuffer class. More...
 
void cancel ()
 Cancels the current buffer. More...
 
uint step ()
 Gets the step size of the current buffer. More...
 
- Public Member Functions inherited from iio.IIOObject
void Dispose ()
 Releases all resource used by the iio.IIOObject object. More...
 

Public Attributes

readonly uint samples_count
 The size of this buffer, in samples. More...
 
readonly Device dev
 The associated iio.Device object. More...
 

Protected Member Functions

override void Destroy ()
 
- Protected Member Functions inherited from iio.IIOObject
 IIOObject (IntPtr hdl)
 

Properties

bool enabled [get, set]
 

Detailed Description

iio.IOBuffer class: The class used for all I/O operations.

Constructor & Destructor Documentation

◆ IOBuffer()

iio.IOBuffer.IOBuffer ( Device  dev,
ChannelsMask  mask,
uint  index = 0 
)
inline

Initializes a new instance of the iio.IOBuffer class.

Parameters
devThe iio.Device object that represents the device where the I/O operations will be performed.
maskThe channels mask to use to create the buffer object.
indexThe index of the hardware buffer. Should be 0 in most cases.
Exceptions
IioLib.IIOExceptionThe buffer could not be created.

Member Function Documentation

◆ cancel()

void iio.IOBuffer.cancel ( )
inline

Cancels the current buffer.

◆ step()

uint iio.IOBuffer.step ( )
inline

Gets the step size of the current buffer.

Member Data Documentation

◆ dev

readonly Device iio.IOBuffer.dev

The associated iio.Device object.

◆ samples_count

readonly uint iio.IOBuffer.samples_count

The size of this buffer, in samples.


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