exiddis::lib::Sequences::IterativeSequence Class Reference
Inheritance diagram for exiddis::lib::Sequences::IterativeSequence:
Public Member Functions | |
| def | __init__ |
| def | setValue |
| def | getNext |
| def | getCurrentValue |
Public Attributes | |
| range | |
| step | |
| value | |
Detailed Description
Class implementing features of iterative (or arithmetic-progression) sequences.
Member Function Documentation
| def exiddis::lib::Sequences::IterativeSequence::__init__ | ( | self, | ||
| id, | ||||
| name, | ||||
| range, | ||||
step = 1, |
||||
users = {} | ||||
| ) |
Create new iterative sequence.
Keyword parameters:
id - sequence id
name - sequence name
range - sequence range (iterval)
step - common difference between each pair of next values (default: 1)
users - map of users with rights to this sequence (default: empty map {})
| def exiddis::lib::Sequences::IterativeSequence::getCurrentValue | ( | self | ) |
Return current value of the sequence.
| def exiddis::lib::Sequences::IterativeSequence::getNext | ( | self | ) |
Return next value of the sequence or raise NextValueOutOfRange if next value would be out of range.
| def exiddis::lib::Sequences::IterativeSequence::setValue | ( | self, | ||
| newValue | ||||
| ) |
Set sequence's current value to new value. Keyword parameters: newValue - new value to be set
The documentation for this class was generated from the following file:
- exiddis/lib/Sequences.py
