|
OpenCMISS-Iron Python Bindings API Documentation
|
|
OpenCMISS-Iron Python Bindings API Documentation
|
Public Member Functions | |
| def | __init__ (self) |
| def | AbsoluteToleranceSet (self, absoluteTolerance) |
| def | ControlLoopGet (self, controlLoopIdentifiers) |
| def | CurrentTimesGet (self) |
| def | Destroy (self) |
| def | Finalise (self) |
| def | IterationsSet (self, startIteration, stopIteration, iterationIncrement) |
| def | LabelGet (self) |
| def | LabelSet (self, label) |
| def | LoadOutputSet (self, outputFrequency) |
| def | MaximumIterationsSet (self, maximumIterations) |
| def | NumberOfIterationsGet (self) |
| def | NumberOfIterationsSet (self, numberOfIterations) |
| def | NumberOfSubLoopsGet (self) |
| def | NumberOfSubLoopsSet (self, numberOfSubLoops) |
| def | OutputTypeGet (self) |
| def | OutputTypeSet (self, outputType) |
| def | TimeInputSet (self, inputOption) |
| def | TimeOutputSet (self, outputFrequency) |
| def | TimesGet (self) |
| def | TimesSet (self, startTime, stopTime, timeIncrement) |
| def | TypeSet (self, loopType) |
Public Attributes | |
| cmiss_type | |
Properties | |
| numberOfIterations = property(NumberOfIterationsGet, NumberOfIterationsSet, None, ) | |
| absoluteTolerance = property(None, AbsoluteToleranceSet, None, ) | |
| timeOutput = property(None, TimeOutputSet, None, ) | |
| timeInput = property(None, TimeInputSet, None, ) | |
| outputType = property(OutputTypeGet, OutputTypeSet, None, ) | |
| label = property(LabelGet, LabelSet, None, ) | |
| loadOutput = property(None, LoadOutputSet, None, ) | |
| numberOfSubLoops = property(NumberOfSubLoopsGet, NumberOfSubLoopsSet, None, ) | |
| type = property(None, TypeSet, None, ) | |
| maximumIterations = property(None, MaximumIterationsSet, None, ) | |
| def iron.ControlLoop.__init__ | ( | self | ) |
| def iron.ControlLoop.AbsoluteToleranceSet | ( | self, | |
| absoluteTolerance | |||
| ) |
| def iron.ControlLoop.ControlLoopGet | ( | self, | |
| controlLoopIdentifiers | |||
| ) |
Returns the specified control loop as indexed by the control loop identifiers from the control loop root. :param controlLoopIdentifiers: The control loop identifiers. :type controlLoopIdentifiers: Array of ints :returns: controlLoop. The specified control loop. :rtype: ControlLoop
| def iron.ControlLoop.CurrentTimesGet | ( | self | ) |
| def iron.ControlLoop.Destroy | ( | self | ) |
| def iron.ControlLoop.Finalise | ( | self | ) |
| def iron.ControlLoop.IterationsSet | ( | self, | |
| startIteration, | |||
| stopIteration, | |||
| iterationIncrement | |||
| ) |
Sets/changes the iteration parameters for a fixed control loop identified by an object. :param startIteration: The start iteration of the fixed control loop to set. :type startIteration: int :param stopIteration: The stop iteration of the fixed control loop to set. :type stopIteration: int :param iterationIncrement: The iteration increment of the fixed control loop to set. :type iterationIncrement: int :rtype: None
| def iron.ControlLoop.LabelGet | ( | self | ) |
| def iron.ControlLoop.LabelSet | ( | self, | |
| label | |||
| ) |
| def iron.ControlLoop.LoadOutputSet | ( | self, | |
| outputFrequency | |||
| ) |
| def iron.ControlLoop.MaximumIterationsSet | ( | self, | |
| maximumIterations | |||
| ) |
| def iron.ControlLoop.NumberOfIterationsGet | ( | self | ) |
| def iron.ControlLoop.NumberOfIterationsSet | ( | self, | |
| numberOfIterations | |||
| ) |
| def iron.ControlLoop.NumberOfSubLoopsGet | ( | self | ) |
| def iron.ControlLoop.NumberOfSubLoopsSet | ( | self, | |
| numberOfSubLoops | |||
| ) |
| def iron.ControlLoop.OutputTypeGet | ( | self | ) |
| def iron.ControlLoop.OutputTypeSet | ( | self, | |
| outputType | |||
| ) |
| def iron.ControlLoop.TimeInputSet | ( | self, | |
| inputOption | |||
| ) |
| def iron.ControlLoop.TimeOutputSet | ( | self, | |
| outputFrequency | |||
| ) |
| def iron.ControlLoop.TimesGet | ( | self | ) |
Returns the time parameters for a time control loop identified by an object. :returns: (The start time for the time control loop, The stop time for the time control loop, The time increment for the time control loop, The current time for the time control loop, The iteration number for the current loop, The iteration number for the time control loop) :rtype: tuple. (float, float, float, float, int, int)
| def iron.ControlLoop.TimesSet | ( | self, | |
| startTime, | |||
| stopTime, | |||
| timeIncrement | |||
| ) |
Sets/changes the time parameters for a time control loop identified by an object. :param startTime: The start time for the time control loop to set. :type startTime: float :param stopTime: The stop time for the time control loop to set. :type stopTime: float :param timeIncrement: The time increment for the time control loop to set. :type timeIncrement: float :rtype: None
| def iron.ControlLoop.TypeSet | ( | self, | |
| loopType | |||
| ) |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
1.8.11 
