uhd::niusrprio::nirio_fifo< data_t > Class Template Reference

#include <uhd/transport/nirio/nirio_fifo.h>

Inheritance diagram for uhd::niusrprio::nirio_fifo< data_t >:

Public Types
typedef boost::shared_ptr< nirio_fifo< data_t > >	sptr

Public Member Functions
	nirio_fifo (niriok_proxy::sptr riok_proxy, fifo_direction_t direction, const std::string &name, uint32_t fifo_instance)
virtual	~nirio_fifo ()
nirio_status	initialize (const size_t requested_depth, size_t &actual_depth, size_t &actual_size)
void	finalize ()
const std::string &	get_name () const
uint32_t	get_channel () const
uint32_t	get_direction () const
uint32_t	get_scalar_type () const
nirio_status	start ()
nirio_status	stop ()
nirio_status	acquire (data_t *&elements, const size_t elements_requested, const uint32_t timeout, size_t &elements_acquired, size_t &elements_remaining)
nirio_status	release (const size_t elements)
nirio_status	read (data_t *buf, const uint32_t num_elements, uint32_t timeout, uint32_t &num_read, uint32_t &num_remaining)
nirio_status	write (const data_t *buf, const uint32_t num_elements, uint32_t timeout, uint32_t &num_remaining)

Member Typedef Documentation

sptr

template<typename data_t >

typedef boost::shared_ptr< nirio_fifo<data_t> > uhd::niusrprio::nirio_fifo< data_t >::sptr

Constructor & Destructor Documentation

nirio_fifo()

template<typename data_t >

nirio_fifo::nirio_fifo	(	niriok_proxy::sptr	riok_proxy,
		fifo_direction_t	direction,
		const std::string &	name,
		uint32_t	fifo_instance
	)

~nirio_fifo()

template<typename data_t >

nirio_fifo::~nirio_fifo ( )

virtual

Member Function Documentation

acquire()

template<typename data_t >

nirio_status nirio_fifo::acquire	(	data_t *&	elements,
		const size_t	elements_requested,
		const uint32_t	timeout,
		size_t &	elements_acquired,
		size_t &	elements_remaining
	)

finalize()

template<typename data_t >

void nirio_fifo::finalize

(

)

get_channel()

template<typename data_t >

uint32_t uhd::niusrprio::nirio_fifo< data_t >::get_channel ( ) const

inline

get_direction()

template<typename data_t >

uint32_t uhd::niusrprio::nirio_fifo< data_t >::get_direction ( ) const

inline

get_name()

template<typename data_t >

const std::string& uhd::niusrprio::nirio_fifo< data_t >::get_name ( ) const

inline

get_scalar_type()

template<typename data_t >

uint32_t uhd::niusrprio::nirio_fifo< data_t >::get_scalar_type ( ) const

inline

initialize()

template<typename data_t >

nirio_status nirio_fifo::initialize	(	const size_t	requested_depth,
		size_t &	actual_depth,
		size_t &	actual_size
	)

read()

template<typename data_t >

nirio_status nirio_fifo::read	(	data_t *	buf,
		const uint32_t	num_elements,
		uint32_t	timeout,
		uint32_t &	num_read,
		uint32_t &	num_remaining
	)

release()

template<typename data_t >

nirio_status nirio_fifo::release

(

const size_t

elements

)

start()

template<typename data_t >

nirio_status nirio_fifo::start

(

)

stop()

template<typename data_t >

nirio_status nirio_fifo::stop

(

)

write()

template<typename data_t >

nirio_status nirio_fifo::write	(	const data_t *	buf,
		const uint32_t	num_elements,
		uint32_t	timeout,
		uint32_t &	num_remaining
	)

---

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

• include/uhd/transport/nirio/nirio_fifo.h
• include/uhd/transport/nirio/nirio_fifo.ipp