Open 3D Engine AzNetworking API Reference  2305.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzNetworking::IBitset Class Referenceabstract

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

#include <IBitset.h>

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

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

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, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, AzNetworking::FixedSizeVectorBitset< 255 >, and AzNetworking::FixedSizeBitsetView.

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

Gets the current value of the specified bit.

Parameters
indexindex 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, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, AzNetworking::FixedSizeVectorBitset< 255 >, and AzNetworking::FixedSizeBitsetView.

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, ElementType >, AzNetworking::FixedSizeBitset< CAPACITY, uint8_t >, AzNetworking::FixedSizeBitset< 1, uint8_t >, AzNetworking::FixedSizeVectorBitset< CAPACITY, ElementType >, AzNetworking::FixedSizeVectorBitset< 255 >, and AzNetworking::FixedSizeBitsetView.

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

Sets the specified bit to the provided value.

Parameters
indexindex of the bit to set
valuevalue to set the bit to

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

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