irio::bfp::DMA Class Reference

Class holding information about one DMA. More...

#include <dma.h>

Inheritance diagram for irio::bfp::DMA:

Public Member Functions
	DMA (const std::string &_name, const FpgaTypes &_fpgaType, const ElemTypes &_elemType, const std::uint32_t &_address, const size_t &_numElem=1)
	Contructor. More...
std::uint32_t	getDMANumber () const
	Returns the number that identifies this DMA. More...
bool	isTargetToHost () const
	Returns whether the DMA is Target to Host (TtH) or not. More...
bool	isHostToTarget () const
	Returns whether the DMA is Host to Target (HtT) or not. More...
Public Member Functions inherited from irio::bfp::Resource
	Resource (const std::string &_name, const FpgaTypes &_fpgaType, const ElemTypes &_elemType, const std::uint32_t &_address, const size_t &_numElem=1)
	Stores information about the resource. More...
std::uint32_t	getAddress () const
	Gets the address of the resource. More...
ElemTypes	getElemType () const
	Gets the element type of the resource. More...
FpgaTypes	getFpgaType () const
	Gets the FPGA type of the resource. More...
const std::string &	getName () const
	Gets the name of the resource. More...
size_t	getNumElem () const
	Gets the number of elements of the resource. More...

Static Public Member Functions
static DMA	processDMA (const pugi::xml_node &dmaNode)
	Creates a DMA object from an XML node. More...

Private Attributes
bool	m_isTargetToHost = false
	If the DMA is TtH or HtT.

Detailed Description

Class holding information about one DMA.

Definition at line 16 of file dma.h.

Constructor & Destructor Documentation

DMA()

irio::bfp::DMA::DMA	(	const std::string &	_name,
		const FpgaTypes &	_fpgaType,
		const ElemTypes &	_elemType,
		const std::uint32_t &	_address,
		const size_t &	_numElem = 1
	)

Contructor.

Initializes the information about the DMA

Parameters

_name	Name of the DMA
_fpgaType	FPGA DMA type
_elemType	Type of the DMA's elements
_address	Address/Number of the DMA
_numElem	Number of the elements in the DMA

Member Function Documentation

getDMANumber()

std::uint32_t irio::bfp::DMA::getDMANumber

(

)

const

Returns the number that identifies this DMA.

Returns

Identifier of the DMA

isHostToTarget()

bool irio::bfp::DMA::isHostToTarget

(

)

const

Returns whether the DMA is Host to Target (HtT) or not.

Returns

True if it is HtT

isTargetToHost()

bool irio::bfp::DMA::isTargetToHost

(

)

const

Returns whether the DMA is Target to Host (TtH) or not.

Returns

True if it is TtH

processDMA()

static DMA irio::bfp::DMA::processDMA ( const pugi::xml_node &  dmaNode )

static

Creates a DMA object from an XML node.

Parameters

dmaNode

XML node with the info of the DMA

Returns

DMA constructed with the information in the XML

---

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

• dma.h