Class SerialContainer<Block>`Abstract`

Abstract container that manages a series of child blocks

Child blocks are managed by changing the length of the container. Might be used to represent a course of a single method.

Type Parameters

Block extends AbstractBlock

Hierarchy (View Summary)

AbstractContainer<Block>
- SerialContainer
  - AbstractCourse

Index

Constructors

Properties

_blocks _initialRow _ownership?

Accessors

blocks container defaultLength index initialRow length ownership rows stage

Methods

accept calculate clearOwnership createBlock getBlock getLast notify notifyContainer propagateBlocks resetLength setLength visitAll

Constructors

constructor

new SerialContainer<Block extends AbstractBlock>(
initialRow: Row,
): SerialContainer<Block>
Constructor
Type Parameters
- Block extends AbstractBlock
Parameters
- initialRow: Row
  initial row for the block
Returns SerialContainer<Block>
Inherited from AbstractContainer.constructor
- Defined in blocks/AbstractBlock.ts:42

Properties

`Protected`_blocks

_blocks: Block[] = []

Blocks within the container

`Protected`_initialRow

_initialRow: Row

Initial row for the block

`Protected` `Optional`_ownership

_ownership?: BlockOwnership

Ownership of this block

Accessors

blocks

get blocks(): readonly Block[]
Read access to the blocks

Returns readonly Block[]
Inherited from AbstractContainer.blocks
- Defined in blocks/AbstractContainer.ts:113

container

get container(): Notifiable | undefined
Allows public access to the container

Returns Notifiable | undefined
Inherited from AbstractContainer.container
- Defined in blocks/AbstractBlock.ts:98

`Protected` `Abstract`defaultLength

get defaultLength(): number
Returns the default length for this container N.b. this is likely to vary depending on the stage

Returns number
- Defined in blocks/SerialContainer.ts:46

index

get index(): number | undefined
Allows public access to the index

Returns number | undefined
Inherited from AbstractContainer.index
- Defined in blocks/AbstractBlock.ts:105

initialRow

get initialRow(): Row
Read access to the initial row

Returns Row
Inherited from AbstractContainer.initialRow
- Defined in blocks/AbstractBlock.ts:56
set initialRow(initialRow: Row): void
Write access to the initial row
Parameters
- initialRow: Row
Returns void
Inherited from AbstractContainer.initialRow
- Defined in blocks/AbstractBlock.ts:63

length

get length(): number
Read access to the length

Returns number
Inherited from AbstractContainer.length
- Defined in blocks/AbstractContainer.ts:106

ownership

set ownership(ownership: BlockOwnership): void
Updates references to the parent container
Parameters
- ownership: BlockOwnership
Returns void
Inherited from AbstractContainer.ownership
- Defined in blocks/AbstractBlock.ts:91

rows

get rows(): number
Estimates the number of rows in the block The estimate doesn't take into account coming round part-way through

Returns number
Inherited from AbstractContainer.rows
- Defined in blocks/AbstractContainer.ts:58

stage

get stage(): Stage
Stage for the block

Returns Stage
Inherited from AbstractContainer.stage
- Defined in blocks/AbstractBlock.ts:77

Methods

accept

accept(...visitors: AbstractVisitor[]): this
Receives a visitor that will be called to process each row
Parameters
- ...visitors: AbstractVisitor[]
Returns this
Inherited from AbstractContainer.accept
- Defined in blocks/AbstractContainer.ts:65

`Protected`calculate

calculate(): void
Does any calculation needed by the block

Returns void
Inherited from AbstractContainer.calculate
- Defined in blocks/AbstractContainer.ts:37

clearOwnership

clearOwnership(): this
Clears references to the parent container

Returns this
Inherited from AbstractContainer.clearOwnership
- Defined in blocks/AbstractBlock.ts:112

`Protected` `Abstract`createBlock

createBlock(initialRow: Row, index: number): Block
Creates a new block for the container

Used by extend() when creating the container or increasing its length.
Parameters
- initialRow: Row
  initial row for the block
- index: number
  index of block in container
Returns Block
- Defined in blocks/SerialContainer.ts:56

getBlock

getBlock(index: number): Block
Read access to a block

Derived classes should provide public access via a more suitably-named method
Parameters
- index: number
Returns Block
Inherited from AbstractContainer.getBlock
- Defined in blocks/AbstractContainer.ts:123

getLast

getLast(): Row
Returns the last row in the block e.g. a course head or a course end (for Stedman)

Returns Row
Inherited from AbstractContainer.getLast
- Defined in blocks/AbstractContainer.ts:45

notify

notify(index: number): void
Receives a notification from a block that has changed
Parameters
- index: number
  index of changed block in container
Returns void
Inherited from AbstractContainer.notify
- Defined in blocks/AbstractContainer.ts:80

`Protected`notifyContainer

notifyContainer(): void
Notifies the parent container

Derived classes should call this whenever the last row changes.

Returns void
Inherited from AbstractContainer.notifyContainer
- Defined in blocks/AbstractBlock.ts:122

`Protected`propagateBlocks

propagateBlocks(index?: number): void
Propagates data between blocks within the container
Parameters
- index: number = 0
  where to start when recalculating
Returns void
Inherited from AbstractContainer.propagateBlocks
- Defined in blocks/AbstractContainer.ts:91

resetLength

resetLength(): this
Resets the course to be the default length

Returns this
- Defined in blocks/SerialContainer.ts:80

setLength

setLength(length: number): this
Write access to the length
Parameters
- length: number
Returns this
- Defined in blocks/SerialContainer.ts:61

`Protected`visitAll

visitAll(visitors: AbstractVisitor[], row: Row): void
Helper function to correctly fan out calls to multiple visitors
Parameters
- visitors: AbstractVisitor[]
- row: Row
Returns void
Inherited from AbstractContainer.visitAll
- Defined in blocks/AbstractBlock.ts:136