Peach :: Generators :: block :: MultiBlockCount :: Class MultiBlockCount

Class MultiBlockCount

Generates the number of occurances of a MultiBlock generator.

Example:

>>> block = MultiBlock([ Static('12345') ], 0, 100, Static(1))
>>> blockCount = MultiBlockCount( block )
>>> print blockCount.getValue()
1

See Also: MultiBlock

Instance Methods

[hide private]

__init__(self, block, defaultOccurs=1)
Base constructor, please call me!

source code

string

getValue(self)
Return data, passed through a transformer if set.

source code

string

getRawValue(self)
Returns size of block as string.

source code

Block

getBlock(self)
Get block object we act on.

source code

setBlock(self, block)
Set block we act on.

source code

Inherited from generator.Generator: __iter__, getGroup, getName, getTransformer, identity, next, reset, setGroup, setName, setTransformer

Method Details

[hide private]

init(self, block, defaultOccurs=1)
(Constructor)

source code

Base constructor, please call me!

Parameters:

block (MultiBlock) - MultiBlock to get count of
defaultSize (number) - To avoid recursion this is our occurs (optional)

Overrides: generator.Generator.__init__

getValue(self)

source code

Return data, passed through a transformer if set.

Returns: string: Returns generated data
Overrides: generator.Generator.getValue

getRawValue(self)

source code

Returns size of block as string.

Returns: string: size of specified Block
Overrides: generator.Generator.getRawValue

getBlock(self)

source code

Get block object we act on.

Returns: Block: current Block

setBlock(self, block)

source code

Set block we act on.

Parameters:

block (Block) - Block to set.

Class MultiBlockCount

__init__(self, block, defaultOccurs=1) (Constructor)

getValue(self)

getRawValue(self)

getBlock(self)

setBlock(self, block)

init(self, block, defaultOccurs=1)
(Constructor)