A standard shared variable.
More...
|
| def | __init__ (self, initial_value=None, initial_payload=None) |
| | Constructs a shared variable. More...
|
| |
| def | write (self, item) |
| | Updates the value of the shared variable. More...
|
| |
| def | read (self) |
| | Access the value of the shared variable. More...
|
| |
| def | storeData (self, payload) |
| | Updates the payload value of the shared variable. More...
|
| |
| def | readData (self) |
| | Access the payload value of the shared variable. More...
|
| |
A standard shared variable.
Values can be accessed with read() or changed with write()
◆ __init__()
| def shares.Share.__init__ |
( |
|
self, |
|
|
|
initial_value = None, |
|
|
|
initial_payload = None |
|
) |
| |
Constructs a shared variable.
- Parameters
-
| initial_value | An optional initial value for the shared variable. |
| initial_payload | An optional value for the second data store variable. |
◆ read()
| def shares.Share.read |
( |
|
self | ) |
|
Access the value of the shared variable.
- Returns
- The value of the shared variable
◆ readData()
| def shares.Share.readData |
( |
|
self | ) |
|
Access the payload value of the shared variable.
- Returns
- The payload value of the shared variable
◆ storeData()
| def shares.Share.storeData |
( |
|
self, |
|
|
|
payload |
|
) |
| |
Updates the payload value of the shared variable.
- Parameters
-
| payload | The new payload for the shared variable |
◆ write()
| def shares.Share.write |
( |
|
self, |
|
|
|
item |
|
) |
| |
Updates the value of the shared variable.
- Parameters
-
| item | The new value for the shared variable |
The documentation for this class was generated from the following file:
1.9.3