Open 3D Engine AzNetworking API Reference  2205.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::FixedSizeBitsetView Class Reference

Creates a view into a subset of an IBitset. More...

#include <FixedSizeBitsetView.h>

Inherits AzNetworking::IBitset.

Public Member Functions

 FixedSizeBitsetView (IBitset &bitset, uint32_t startOffset, uint32_t count)
 
void SetBit (uint32_t index, bool value) override
 
bool GetBit (uint32_t index) const override
 
bool AnySet () const override
 
uint32_t GetValidBitCount () const override
 

Detailed Description

Creates a view into a subset of an IBitset.

Constructor & Destructor Documentation

◆ FixedSizeBitsetView()

AzNetworking::FixedSizeBitsetView::FixedSizeBitsetView ( IBitset bitset,
uint32_t  startOffset,
uint32_t  count 
)
inline

Construct a bitset view.

Parameters
bitseta bitset to create the view from
startOffsetstarting bit
counttotal number of bits to use

Member Function Documentation

◆ AnySet()

bool AzNetworking::FixedSizeBitsetView::AnySet ( ) const
inlineoverridevirtual

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

Implements AzNetworking::IBitset.

◆ GetBit()

bool AzNetworking::FixedSizeBitsetView::GetBit ( uint32_t  index) const
inlineoverridevirtual

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

Implements AzNetworking::IBitset.

◆ GetValidBitCount()

uint32_t AzNetworking::FixedSizeBitsetView::GetValidBitCount ( ) const
inlineoverridevirtual

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

Implements AzNetworking::IBitset.

◆ SetBit()

void AzNetworking::FixedSizeBitsetView::SetBit ( uint32_t  index,
bool  value 
)
inlineoverridevirtual

Sets the specified bit to the provided value.

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

Implements AzNetworking::IBitset.


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