AzNetworking::IBitset Class Reference

Interface for a structure optimized for representing an array of bits. More...

#include <IBitset.h>

Inherited by AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeVectorBitset< 255 >, AzNetworking::FixedSizeBitset< SIZE, ElementType >, AzNetworking::FixedSizeBitsetView, and AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >.

Public Member Functions
virtual void	SetBit (uint32_t index, bool value)=0
virtual bool	GetBit (uint32_t index) const =0
virtual bool	AnySet () const =0
virtual uint32_t	GetValidBitCount () const =0

Detailed Description

Interface for a structure optimized for representing an array of bits.

Member Function Documentation

AnySet()

virtual bool AzNetworking::IBitset::AnySet ( ) const

pure virtual

Returns true if any bit is raised, false otherwise.

Returns

boolean true if any bit is raised, false if all bits are lowered

Implemented in AzNetworking::FixedSizeBitset< SIZE, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeBitsetView, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, and AzNetworking::FixedSizeVectorBitset< 255 >.

GetBit()

virtual bool AzNetworking::IBitset::GetBit ( uint32_t  index ) const

pure virtual

Gets the current value of the specified bit.

Parameters

index

index of the bit to retrieve the value of

Returns

boolean true if the bit is set, false otherwise

Implemented in AzNetworking::FixedSizeBitset< SIZE, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeBitsetView, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, and AzNetworking::FixedSizeVectorBitset< 255 >.

GetValidBitCount()

virtual uint32_t AzNetworking::IBitset::GetValidBitCount ( ) const

pure virtual

Returns the number of bits that are represented in this fixed size bitset.

Returns

the number of bits that are represented in this fixed size bitset

Implemented in AzNetworking::FixedSizeBitset< SIZE, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeBitsetView, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, and AzNetworking::FixedSizeVectorBitset< 255 >.

SetBit()

virtual void AzNetworking::IBitset::SetBit ( uint32_t  index, bool  value  )

pure virtual

Sets the specified bit to the provided value.

Parameters

index	index of the bit to set
value	value to set the bit to

Implemented in AzNetworking::FixedSizeBitset< SIZE, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeBitsetView, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, and AzNetworking::FixedSizeVectorBitset< 255 >.

---

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

• Code/Framework/AzNetworking/AzNetworking/DataStructures/IBitset.h