wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue > Class Template Reference

The LimitedHandleResource class is a way to track handles. More...

#include <wpi/hal/handles/LimitedHandleResource.hpp>

Inheritance diagram for wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >:

Public Member Functions
	LimitedHandleResource ()=default
	LimitedHandleResource (const LimitedHandleResource &)=delete
LimitedHandleResource &	operator= (const LimitedHandleResource &)=delete
THandle	Allocate ()
int16_t	GetIndex (THandle handle)
std::shared_ptr< TStruct >	Get (THandle handle)
void	Free (THandle handle)
void	ResetHandles () override
Public Member Functions inherited from wpi::hal::HandleBase
	HandleBase ()
	~HandleBase ()
	HandleBase (const HandleBase &)=delete
HandleBase &	operator= (const HandleBase &)=delete

Friends
class	LimitedHandleResourceTest

Additional Inherited Members
Static Public Member Functions inherited from wpi::hal::HandleBase
static void	ResetGlobalHandles ()
Protected Attributes inherited from wpi::hal::HandleBase
int16_t	m_version

Detailed Description

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>
class wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >

The LimitedHandleResource class is a way to track handles.

This version allows a limited number of handles that are allocated sequentially.

Template Parameters

THandle	The Handle Type (Must be typedefed from HAL_Handle)
TStruct	The struct type held by this resource
size	The number of resources allowed to be allocated
enumValue	The type value stored in the handle

Constructor & Destructor Documentation

LimitedHandleResource() [1/2]

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::LimitedHandleResource ( )

default

LimitedHandleResource() [2/2]

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::LimitedHandleResource ( const LimitedHandleResource< THandle, TStruct, size, enumValue > & )

delete

Member Function Documentation

Allocate()

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

THandle wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::Allocate

(

)

Free()

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

void wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::Free

(

THandle

handle

)

Get()

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

std::shared_ptr< TStruct > wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::Get

(

THandle

handle

)

GetIndex()

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

int16_t wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::GetIndex ( THandle handle )

inline

operator=()

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

LimitedHandleResource & wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::operator= ( const LimitedHandleResource< THandle, TStruct, size, enumValue > & )

delete

ResetHandles()

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

void wpi::hal::LimitedHandleResource< THandle, TStruct, size, enumValue >::ResetHandles ( )

overridevirtual

Reimplemented from wpi::hal::HandleBase.

Friends And Related Symbol Documentation

LimitedHandleResourceTest

template<typename THandle, typename TStruct, int16_t size, HAL_HandleEnum enumValue>

friend class LimitedHandleResourceTest

friend

---

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

• wpi/hal/handles/LimitedHandleResource.hpp