CINOSBusHookCategory Class Reference

Public Types
enum	EFlags { eFlgNone = 0x00000000 , eFlgEnabled = 0x00000001 }
	Category flags.

Public Member Functions
	CINOSBusHookCategory ()
	Create bus hook category handler.
	~CINOSBusHookCategory ()
	Destroy bus hook category handler.
uint32	Setup (uint32 auCycletime, uint32 auFlags)
	Setup hook category with given cycle time.
uint32	SetupDone (uint16 auHooks)
	Finalysing hook category setup with given max. number of hooks.
uint32	Shutdown (class CINOSBusHooks *apParent)
	Shutdown hook category.
uint32	Enable ()
	Enable category.
uint32	Disable ()
	Disable category.
bool	IsCyclenumberValid (uint8 auCyclenumber)
	Check whether the given cycle number is in a valid range.
bool	IsCycletimeValid (uint32 auCycletimeNs)
	Check whether the given cycle time is valid.

Protected Member Functions
	DECLARE_DYNAMIC (CINOSBusHookCategory)

Protected Attributes
uint32	m_uFlags {}
uint32	m_uCycletimeNs {}
uint32	m_uCycles {}
CINOSBusHookCycle *	m_pCycles {}

Friends
class	CINOSBusHooks
class	CINOSBusHookCore

Member Function Documentation

IsCyclenumberValid()

bool CINOSBusHookCategory::IsCyclenumberValid

(

uint8

auCyclenumber

)

Check whether the given cycle number is in a valid range.

Parameters

[in]

auCyclenumber

Cycle number to check

Returns

true if valid, false otherwise

IsCycletimeValid()

bool CINOSBusHookCategory::IsCycletimeValid

(

uint32

auCycletimeNs

)

Check whether the given cycle time is valid.

Parameters

[in]

auCycletime

Cycle time to check

Returns

true if valid, false otherwise

Setup()

uint32 CINOSBusHookCategory::Setup	(	uint32	auCycletime,
		uint32	auFlags
	)

Setup hook category with given cycle time.

Parameters

[in]

auCycletime

Requested cycle time this category handles

Returns

INOS_OK or an appropriate error

SetupDone()

uint32 CINOSBusHookCategory::SetupDone

(

uint16

auHooks

)

Finalysing hook category setup with given max. number of hooks.

Parameters

[in]

auHooks

Max. number of hooks the hook handler owns

Returns

INOS_OK or an appropriate error

Shutdown()

uint32 CINOSBusHookCategory::Shutdown

(

class CINOSBusHooks *

apParent

)

Shutdown hook category.

Parameters

[in]

apParent

Pointer to parent hook handler

Returns

INOS_OK or an appropriate error

Member Data Documentation

m_pCycles

CINOSBusHookCycle* CINOSBusHookCategory::m_pCycles {}

protected

array of cycle handlers

m_uCycles

uint32 CINOSBusHookCategory::m_uCycles {}

protected

number of cycles

---

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

• /home/jenkins/workspace/inos_doxygen/os/inos/inc/cinosbushooks.h