xaiefal::XAieGroupEventHandle Class Reference

class for group event resource reference More...

#include <xaiefal-groupevent.hpp>

Inheritance diagram for xaiefal::XAieGroupEventHandle:

Public Member Functions
	XAieGroupEventHandle ()=delete
	XAieGroupEventHandle (std::shared_ptr< XAieDevHandle > DevHd, std::shared_ptr< XAieGroupEvent > gEPtr)
void	setGroupEvents (uint32_t Comp)
uint32_t	getGroupEvents () const
XAie_Events	getEvent () 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
virtual XAieRscStat	getRscStat (const std::string &GName) 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::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 reference

Constructor & Destructor Documentation

XAieGroupEventHandle() [1/2]

xaiefal::XAieGroupEventHandle::XAieGroupEventHandle ( )

delete

XAieGroupEventHandle() [2/2]

xaiefal::XAieGroupEventHandle::XAieGroupEventHandle ( std::shared_ptr< XAieDevHandle > DevHd, std::shared_ptr< XAieGroupEvent > gEPtr )

inline

Member Function Documentation

_release()

AieRC xaiefal::XAieGroupEventHandle::_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::XAieGroupEventHandle::_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::XAieGroupEventHandle::_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::XAieGroupEventHandle::_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.

getEvent()

XAie_Events xaiefal::XAieGroupEventHandle::getEvent ( ) const

inline

This function returns group event

Returns

group event

getGroupEvents()

uint32_t xaiefal::XAieGroupEventHandle::getGroupEvents ( ) const

inline

This function is to get group event events enabling bits.

Returns

group event events enabling bits.

setGroupEvents()

void xaiefal::XAieGroupEventHandle::setGroupEvents ( uint32_t Comp )

inline

This function is to set group event events enabling bits.

Parameters

Comp	composition

If the events bits is set, when the corresponding events are set, the group event will set.

---

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

• src/rsc/xaiefal-groupevent.hpp