IIOMMap Class Reference

#include <IIOMMap.H>

Inheritance diagram for IIOMMap:

Collaboration diagram for IIOMMap:

Public Member Functions
	IIOMMap ()
	Constructor. More...
virtual	~IIOMMap ()
	Destructor. More...
int	open (void)
int	open (int count, int sizeIn)
int	resizeMMapBlocks (int count, int sizeIn)
int	close (void)
template<typename TYPE >
int	read (uint N, const Eigen::Array< TYPE, Eigen::Dynamic, Eigen::Dynamic > &array)
double	getMaxDelay (float fs)
Public Member Functions inherited from IIO
	IIO ()
virtual	~IIO ()
int	findDevicesByChipName (std::string chipName)
uint	getDeviceCnt ()
uint	getChCnt ()
void	printInfo ()
int	open (void)
int	close (void)
int	getChFrameSize (void)
int	getDevFrameSize (void)
template<typename TYPE >
int	getReadArray (uint N, Eigen::Array< TYPE, Eigen::Dynamic, Eigen::Dynamic > &array)
template<typename TYPE >
int	getReadArraySampleCount (Eigen::Array< TYPE, Eigen::Dynamic, Eigen::Dynamic > &array)
template<typename TYPE >
int	read (uint N, const Eigen::Array< TYPE, Eigen::Dynamic, Eigen::Dynamic > &array)
int	enable (bool enable)
int	getChannelBufferCnt ()
int	setChannelBufferCnt (int chBufCnt)

Private Attributes
vector< MMappedBlocks >	mMappedBlocks
	The memory mapped blocks. More...

Detailed Description

Examples:

IIOMMapTest.C.

Definition at line 186 of file IIOMMap.H.

Constructor & Destructor Documentation

IIOMMap()

IIOMMap::IIOMMap ( )

inline

Constructor.

Definition at line 189 of file IIOMMap.H.

~IIOMMap()

virtual IIOMMap::~IIOMMap ( )

inlinevirtual

Destructor.

Definition at line 192 of file IIOMMap.H.

Member Function Documentation

close()

int IIOMMap::close ( void  )

inline

Close all of the devices.

Returns

NO_ERROR on success, or the appropriate error number on failure.

Examples:

IIOMMapTest.C.

Definition at line 255 of file IIOMMap.H.

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxDelay()

double IIOMMap::getMaxDelay ( float  fs )

inline

Get the maximum available time in all of the buffers.

Returns

The maximum duration the buffers can hold.

Examples:

IIOMMapTest.C.

Definition at line 317 of file IIOMMap.H.

Here is the caller graph for this function:

open() [1/2]

int IIOMMap::open ( void  )

inline

Overload the IIO::open method. doesn't make sense here.

Returns

NO_ERROR on success, or the appropriate error number on failure.

Examples:

IIOMMapTest.C.

Definition at line 199 of file IIOMMap.H.

Here is the call graph for this function:

Here is the caller graph for this function:

open() [2/2]

int IIOMMap::open ( int  count, int  sizeIn  )

inline

Open all of the devices all channels.

Parameters

count	The number of memory buffers to use.
sizeIn	The size of each of the memory buffers in samples per channel.

Returns

NO_ERROR on success, or the appropriate error number on failure.

Definition at line 208 of file IIOMMap.H.

Here is the call graph for this function:

read()

template<typename TYPE >

int IIOMMap::read ( uint  N, const Eigen::Array< TYPE, Eigen::Dynamic, Eigen::Dynamic > &  array  )

inline

Read N samples from each channel.

Parameters

N	The number of samples to read from each channel.
array	The array to fill with data.

Returns

NO_ERROR on success, or the appropriate error on failure.

Template Parameters

TYPE	the type of the samples to read in, for example signed 16 bit is short int.

Examples:

IIOMMapTest.C.

Definition at line 267 of file IIOMMap.H.

Here is the call graph for this function:

Here is the caller graph for this function:

resizeMMapBlocks()

int IIOMMap::resizeMMapBlocks ( int  count, int  sizeIn  )

inline

Resize the memory mapped blocks.

Parameters

count	The number of memory buffers to use.
sizeIn	The size of each of the memory buffers in samples per channel.

Returns

NO_ERROR on success, or the appropriate error number on failure.

Definition at line 239 of file IIOMMap.H.

Here is the call graph for this function:

Member Data Documentation

mMappedBlocks

vector<MMappedBlocks> IIOMMap::mMappedBlocks

private

The memory mapped blocks.

Definition at line 187 of file IIOMMap.H.

---

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

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