type Result

Known Subclasses:

• result_commands.Result_command
• , Result_string

A basic result object returned from a slave processor via return_object.

This a very basic result and shouldn't be overridden unless you are also modifying the process_result method in all the processors in the framework (i.e. currently for implementors only). Most users should override Result_command.

This result basically acts as storage for the following fields completed, memo_id, processor_rank.

Results should only be created on slave processors.

See Also:

multi.processor.return_object., multi.processor.process_result., multi.processor.Result_command.

Instance Methods

__init__(self, processor, completed)
Initialise a result.

Instance Variables

completed
A flag used in batching result returns to indicate that the sequence has completed.

memo_id
The memo_id of the Slave_command currently being processed on this processor.

rank
The rank of the current processor, used in command scheduling on the master processor.

Method Details

__init__(self, processor, completed)
(Constructor)

Initialise a result.

This object is designed for subclassing and __init__ should be called via the super() function.

Parameters:

• processor (Processor instance) - Processor the processor instance we are running in.
• completed (bool) - A flag used in batching result returns to indicate that the sequence of batched result commands has completed, the flag should be set by slave_commands. The value should be the value passed to a Slave_commands run method if it is the final result being returned otherwise it should be False.

Overrides: object.__init__

See Also: multi.processor.Processor.

Note: The requirement for the user to know about completed will hopefully disappear with some slight of hand in the Slave_command and it may even disappear completely.

Instance Variable Details

completed

A flag used in batching result returns to indicate that the sequence has completed.

This is an optimisation to prevent the sending an extra batched result queue completion result being sent, it may be an over early optimisation.

memo_id

The memo_id of the Slave_command currently being processed on this processor.

This value is set by the return_object method to the current Slave_commands memo_id.