class for group event resource More...

#include <xaiefal-groupevent.hpp>

Inheritance diagram for xaiefal::XAieGroupEvent:

Public Member Functions
	XAieGroupEvent ()=delete
	XAieGroupEvent (std::shared_ptr< XAieDevHandle > DevHd, XAie_LocType Loc, XAie_ModuleType Mod, XAie_Events gEvent)
XAie_Events	getEvent () const
AieRC	attachHandle (const XAieGroupEventHandle *Hid, uint32_t Comp)
AieRC	startHandle (const XAieGroupEventHandle *Hid)
AieRC	stopHandle (const XAieGroupEventHandle *Hid)
AieRC	removeHandle (const XAieGroupEventHandle *Hid)
uint32_t	getRscIdfromEvent (XAie_Events Event)
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 ()

Protected Member Functions
AieRC	_reserve ()
AieRC	_release ()
AieRC	_start ()
AieRC	_stop ()

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

class for group event resource

Constructor & Destructor Documentation

◆ XAieGroupEvent() [1/2]

xaiefal::XAieGroupEvent::XAieGroupEvent ( )

delete

◆ XAieGroupEvent() [2/2]

xaiefal::XAieGroupEvent::XAieGroupEvent	(	std::shared_ptr< XAieDevHandle >	DevHd,
		XAie_LocType	Loc,
		XAie_ModuleType	Mod,
		XAie_Events	gEvent )

inline

Member Function Documentation

◆ _release()

AieRC xaiefal::XAieGroupEvent::_release ( )

inlineprotectedvirtual

This function will be called by release(). It allows child class to implement its own resource release.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ _reserve()

AieRC xaiefal::XAieGroupEvent::_reserve ( )

inlineprotectedvirtual

This function will be called by reserve(). It allows child class to implement its own resource reservation.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ _start()

AieRC xaiefal::XAieGroupEvent::_start ( )

inlineprotectedvirtual

This function will be called by start(). It allows child class to implement its own resource start.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ _stop()

AieRC xaiefal::XAieGroupEvent::_stop ( )

inlineprotectedvirtual

This function will be called by stop(). It allows child class to implement its own resource stop.

Returns: XAIE_OK for success, error code for failure.

Reimplemented from xaiefal::XAieRsc.

◆ attachHandle()

AieRC xaiefal::XAieGroupEvent::attachHandle	(	const XAieGroupEventHandle *	Hid,
		uint32_t	Comp )

inline

This function is to attach group event handle.

Parameters

Hid	group event handle id
Comp	composition

Returns: XAIE_OK for success, and error code for failure.

If the group event is not reserved, this function will add the input reference to the reference list, and reserve the group event resource. If the group event has been reserved, it will only add the reference to the list if the group event enabling setting is the same as what's been reserved.

◆ getEvent()

XAie_Events xaiefal::XAieGroupEvent::getEvent ( ) const

inline

This function is to return group event

Returns: Group event

◆ getRscIdfromEvent()

uint32_t xaiefal::XAieGroupEvent::getRscIdfromEvent ( XAie_Events Event )

inline

◆ removeHandle()

AieRC xaiefal::XAieGroupEvent::removeHandle ( const XAieGroupEventHandle * Hid )

inline

This function is to remove the group event handle.

Parameters

Hid	groupe event handle ID

Returns: XAIE_OK for success, and error code for failure

This function will remove the referece from the references list, if the list is empty after removal, it will release the group event resource.

◆ startHandle()

AieRC xaiefal::XAieGroupEvent::startHandle ( const XAieGroupEventHandle * Hid )

inline

This function is to start the group event handle.

Parameters

Hid	groupe event handle id

Returns: XAIE_OK for success, and error code for failure

This function will validate the reference, if it is valid, it will add it to the inuse references list, if the list was empty, it will configure the group event.

◆ stopHandle()

AieRC xaiefal::XAieGroupEvent::stopHandle ( const XAieGroupEventHandle * Hid )

inline

This function is to stop the group event handle.

Parameters

Hid	groupe event handle ID

Returns: XAIE_OK for success, and error code for failure

This function will remove the referece from the inuse references list, if the list is empty after removal, it will reset the group event configuration.

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

src/rsc/xaiefal-groupevent.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XAieGroupEvent() [1/2]

◆ XAieGroupEvent() [2/2]

Member Function Documentation

◆ _release()

◆ _reserve()

◆ _start()

◆ _stop()

◆ attachHandle()

◆ getEvent()

◆ getRscIdfromEvent()

◆ removeHandle()

◆ startHandle()

◆ stopHandle()