xaiefal::XAieUserEvent Class Reference

AI engine user event resource class. More...

#include <xaiefal-events.hpp>

Inheritance diagram for xaiefal::XAieUserEvent:

Public Member Functions
	XAieUserEvent ()=delete
	XAieUserEvent (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod)
	XAieUserEvent (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod)
AieRC	getEvent (XAie_Events &Event) const
Public Member Functions inherited from xaiefal::XAieSingleTileRsc
	XAieSingleTileRsc ()=delete
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod)
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType Type)
	XAieSingleTileRsc (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod)
	XAieSingleTileRsc (XAieDev &Dev, XAie_LocType Loc, XAie_ModuleType Mod, XAieRscType Type)
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc)
	XAieSingleTileRsc (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAieRscType Type)
	XAieSingleTileRsc (XAieDev &Dev, XAie_LocType Loc, XAieRscType Type)
virtual	~XAieSingleTileRsc ()
XAie_LocType	loc () const
XAie_ModuleType	mod () const
AieRC	getRscId (XAie_LocType &OutLoc, XAie_ModuleType &OutMod, uint32_t &OutRscId)
virtual XAieRscStat	getRscStat (const std::string &GName) const
Public Member Functions inherited from xaiefal::XAieRsc
	XAieRsc ()=delete
	XAieRsc (std::shared_ptr< XAieDevHandle > DevHd)
	XAieRsc (std::shared_ptr< XAieDevHandle > DevHd, XAieRscType Type)
	XAieRsc (XAieDev &Dev)
virtual	~XAieRsc ()
AieRC	setPreferredId (uint32_t id, bool isStaticAllocated=false)
uint32_t	getPreferredId ()
AieRC	reserve ()
AieRC	release ()
AieRC	free ()
AieRC	start ()
AieRC	stop ()
bool	isInitialized () const
bool	isReserved () const
bool	isConfigured () const
bool	isRunning () const
void	getReservedRscs (std::vector< XAieUserRsc > &vOutRscs) const
AieRC	getRscs (std::vector< XAieUserRsc > &vOutRscs)
AieRC	setRscs (std::vector< XAieUserRsc > &vInRscs)
virtual XAieRscType	getRscType () const
XAie_DevInst *	dev ()
virtual uint32_t	getAvailManagedRscs ()
virtual XAieRscType	getManagedRscsType ()

Additional Inherited Members
Protected Attributes inherited from xaiefal::XAieSingleTileRsc
XAie_LocType	Loc
XAie_ModuleType	Mod
Protected Attributes inherited from xaiefal::XAieRsc
XAieRscState	State
XAieRscType	Type
std::shared_ptr< XAieDevHandle >	AieHd
uint32_t	preferredId
uint32_t	reservedId
std::vector< XAieUserRsc >	vRscs

Detailed Description

AI engine user event resource class.

Constructor & Destructor Documentation

XAieUserEvent() [1/3]

xaiefal::XAieUserEvent::XAieUserEvent ( )

delete

XAieUserEvent() [2/3]

xaiefal::XAieUserEvent::XAieUserEvent ( std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod )

inline

XAieUserEvent() [3/3]

xaiefal::XAieUserEvent::XAieUserEvent ( XAieDev & Dev, XAie_LocType Loc, XAie_ModuleType Mod )

inline

Member Function Documentation

getEvent()

AieRC xaiefal::XAieUserEvent::getEvent ( XAie_Events & Event ) const

inline

This function returns user event. It needs to be called after reserve() succeeds.

Parameters

Event

returns user event

Returns

XAIE_OK for success, error code for failure

---

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

• src/rsc/xaiefal-events.hpp