IIOChannel Class Reference

#include <IIOChannel.H>

Collaboration diagram for IIOChannel:

Public Member Functions
int	scanElements (std::string scanPath, uint cIndex)
void	printInfo ()
bool	isReadCh (void)

Public Attributes
unsigned int	index
	The index in the interleaved stream. More...
std::string	chName
	The name of each of the enabled channels. More...
std::string	chGenericName
	The generic name of each of the enabled channels. More...
bool	isLittleEndian
	Indicates whether the channel is little endian. More...
bool	isSigned
	Indicates whether the data is signed or unsigned. More...
uint	bitCnt
	The number of bits in one word of data for one channel. More...
uint	deviceBitCnt
	The number of bits in one device word - this is all the channels combined into a device frame. More...
uint	bitShiftCnt
	The number of bits to shift the channel word down by to get a proper reading. More...

Detailed Description

Maintains channel information for an IIO device. Adds capability for the channel to scan its elements and work out its nature.

Definition at line 95 of file IIOChannel.H.

Member Function Documentation

isReadCh()

bool IIOChannel::isReadCh ( void  )

inline

Find if this channel is an input channel or and output channel.

Returns

true if this is a read channel, false if it is a write channel.

Definition at line 162 of file IIOChannel.H.

printInfo()

void IIOChannel::printInfo ( )

inline

Definition at line 142 of file IIOChannel.H.

scanElements()

int IIOChannel::scanElements ( std::string  scanPath, uint  cIndex  )

inline

Setup the relevant channel parameters from the scan_elements directory in sysfs

Parameters

scanPath	The path to the scan_elements directory
cIndex	The sysfs channel element to scan

Returns

NO_ERROR, or the arropriate error on failure.

Definition at line 112 of file IIOChannel.H.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bitCnt

uint IIOChannel::bitCnt

The number of bits in one word of data for one channel.

Definition at line 103 of file IIOChannel.H.

bitShiftCnt

uint IIOChannel::bitShiftCnt

The number of bits to shift the channel word down by to get a proper reading.

Definition at line 105 of file IIOChannel.H.

chGenericName

std::string IIOChannel::chGenericName

The generic name of each of the enabled channels.

Definition at line 100 of file IIOChannel.H.

chName

std::string IIOChannel::chName

The name of each of the enabled channels.

Definition at line 99 of file IIOChannel.H.

deviceBitCnt

uint IIOChannel::deviceBitCnt

The number of bits in one device word - this is all the channels combined into a device frame.

Definition at line 104 of file IIOChannel.H.

index

unsigned int IIOChannel::index

The index in the interleaved stream.

Definition at line 98 of file IIOChannel.H.

isLittleEndian

bool IIOChannel::isLittleEndian

Indicates whether the channel is little endian.

Definition at line 101 of file IIOChannel.H.

isSigned

bool IIOChannel::isSigned

Indicates whether the data is signed or unsigned.

Definition at line 102 of file IIOChannel.H.

---

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

• /tmp/gtkiostream/include/IIO/IIOChannel.H