Documentation

EcBlocks
in package

Encapsulates a set of error-correction blocks in one symbol version.

Most versions will use blocks of differing sizes within one version, so, this encapsulates the parameters for each set of blocks. It also holds the number of error-correction codewords per block since it will be the same across all blocks within one version.

Table of Contents

$ecBlocks  : array<string|int, EcBlock>
List of EC blocks.
$ecCodewordsPerBlock  : int
Number of EC codewords per block.
__construct()  : mixed
getEcBlocks()  : array<string|int, EcBlock>
Returns the EC blocks included in this collection.
getEcCodewordsPerBlock()  : int
Returns the number of EC codewords per block.
getNumBlocks()  : int
Returns the total number of EC block appearances.
getTotalEcCodewords()  : int
Returns the total count of EC codewords.

Properties

$ecCodewordsPerBlock

Number of EC codewords per block.

private int $ecCodewordsPerBlock

Methods

__construct()

public __construct(int $ecCodewordsPerBlock, EcBlock ...$ecBlocks) : mixed
Parameters
$ecCodewordsPerBlock : int
$ecBlocks : EcBlock
Return values
mixed

getEcBlocks()

Returns the EC blocks included in this collection.

public getEcBlocks() : array<string|int, EcBlock>
Return values
array<string|int, EcBlock>

getEcCodewordsPerBlock()

Returns the number of EC codewords per block.

public getEcCodewordsPerBlock() : int
Return values
int

getNumBlocks()

Returns the total number of EC block appearances.

public getNumBlocks() : int
Return values
int

getTotalEcCodewords()

Returns the total count of EC codewords.

public getTotalEcCodewords() : int
Return values
int

Search results