Classes | Public Member Functions | Private Attributes | List of all members
OpenRTM_aist.PeriodicTask.PeriodicTask Class Reference
Inheritance diagram for OpenRTM_aist.PeriodicTask.PeriodicTask:
Inheritance graph
[legend]

Classes

class  alive_t
 
class  statistics_t
 
class  suspend_t
 

Public Member Functions

def __del__ (self, Task=OpenRTM_aist.Task)
 dtor More...
 
def __init__ (self)
 ctor More...
 
def activate (self)
 Starting the task. More...
 
def executionMeasure (self, value)
 virtual void executionMeasure(bool value); More...
 
def executionMeasureCount (self, n)
 virtual void executionMeasureCount(int n); More...
 
def finalize (self)
 Finalizing the task. More...
 
def getExecStat (self)
 virtual TimeMeasure::Statistics getExecStat(); More...
 
def getPeriodStat (self)
 virtual TimeMeasure::Statistics getPeriodStat(); More...
 
def periodicMeasure (self, value)
 virtual void periodicMeasure(bool value); More...
 
def periodicMeasureCount (self, n)
 virtual void periodicMeasureCount(int n); More...
 
def resume (self)
 Resuming the suspended task. More...
 
def setPeriod (self, period)
 Setting task execution period. More...
 
def setTask (self, func, delete_in_dtor=True)
 Setting task execution function. More...
 
def signal (self)
 Executing the suspended task one tick. More...
 
def sleep (self)
 virtual void sleep(); More...
 
def suspend (self)
 Suspending the task. More...
 
def svc (self)
 virtual int svc(); More...
 
def updateExecStat (self)
 virtual void updateExecStat(); More...
 
def updatePeriodStat (self)
 virtual void updatePeriodStat(); More...
 
- Public Member Functions inherited from OpenRTM_aist.Task.Task
def __del__ (self)
 
def __init__ (self)
 
def activate (self)
 
def close (self, flags=0)
 
def finalize (self)
 
def open (self, args=None)
 
def reset (self)
 
def resume (self)
 
def suspend (self)
 
def svc (self)
 
def svc_run (self)
 
def wait (self)
 

Private Attributes

 _alive
 
 _deleteInDtor
 
 _execCount
 
 _execCountMax
 
 _execMeasure
 
 _execStat
 
 _execTime
 
 _func
 
 _nowait
 
 _period
 
 _periodCount
 
 _periodCountMax
 
 _periodMeasure
 
 _periodStat
 
 _periodTime
 
 _suspend
 

Detailed Description

 

Definition at line 46 of file PeriodicTask.py.

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.PeriodicTask.PeriodicTask.__init__ (   self)

ctor

Definition at line 57 of file PeriodicTask.py.

◆ __del__()

def OpenRTM_aist.PeriodicTask.PeriodicTask.__del__ (   self,
  Task = OpenRTM_aist.Task 
)

dtor

Definition at line 90 of file PeriodicTask.py.

Member Function Documentation

◆ activate()

def OpenRTM_aist.PeriodicTask.PeriodicTask.activate (   self)

Starting the task.

Starting a thread to execute a task. If the task/thread is started properly, it will return 'TRUE'. if the task/thread are already started or task function object is not set, 'FALSE' will be returned.

Returns
true: normal start, false: already started or task is not set

virtual void activate();

Definition at line 120 of file PeriodicTask.py.

◆ executionMeasure()

def OpenRTM_aist.PeriodicTask.PeriodicTask.executionMeasure (   self,
  value 
)

virtual void executionMeasure(bool value);

Definition at line 284 of file PeriodicTask.py.

◆ executionMeasureCount()

def OpenRTM_aist.PeriodicTask.PeriodicTask.executionMeasureCount (   self,
  n 
)

virtual void executionMeasureCount(int n);

Definition at line 297 of file PeriodicTask.py.

◆ finalize()

def OpenRTM_aist.PeriodicTask.PeriodicTask.finalize (   self)

Finalizing the task.

Finalizing the task running.

virtual void finalize();

Definition at line 147 of file PeriodicTask.py.

◆ getExecStat()

def OpenRTM_aist.PeriodicTask.PeriodicTask.getExecStat (   self)

virtual TimeMeasure::Statistics getExecStat();

Definition at line 335 of file PeriodicTask.py.

◆ getPeriodStat()

def OpenRTM_aist.PeriodicTask.PeriodicTask.getPeriodStat (   self)

virtual TimeMeasure::Statistics getPeriodStat();

Definition at line 348 of file PeriodicTask.py.

◆ periodicMeasure()

def OpenRTM_aist.PeriodicTask.PeriodicTask.periodicMeasure (   self,
  value 
)

virtual void periodicMeasure(bool value);

Definition at line 310 of file PeriodicTask.py.

◆ periodicMeasureCount()

def OpenRTM_aist.PeriodicTask.PeriodicTask.periodicMeasureCount (   self,
  n 
)

virtual void periodicMeasureCount(int n);

Definition at line 322 of file PeriodicTask.py.

◆ resume()

def OpenRTM_aist.PeriodicTask.PeriodicTask.resume (   self)

Resuming the suspended task.

Resuming the suspended task

virtual int resume(void);

Definition at line 193 of file PeriodicTask.py.

◆ setPeriod()

def OpenRTM_aist.PeriodicTask.PeriodicTask.setPeriod (   self,
  period 
)

Setting task execution period.

Parameters
periodExecution period [sec]

virtual void setPeriod(double period); virtual void setPeriod(TimeValue& period);

Definition at line 262 of file PeriodicTask.py.

◆ setTask()

def OpenRTM_aist.PeriodicTask.PeriodicTask.setTask (   self,
  func,
  delete_in_dtor = True 
)

Setting task execution function.

Parameters
funcSet int (*)() type function pointer

virtual bool setTask(TaskFuncBase* func, bool delete_in_dtor = true);

Definition at line 238 of file PeriodicTask.py.

◆ signal()

def OpenRTM_aist.PeriodicTask.PeriodicTask.signal (   self)

Executing the suspended task one tick.

Executing the suspended task one tick

virtual void signal();

Definition at line 217 of file PeriodicTask.py.

◆ sleep()

def OpenRTM_aist.PeriodicTask.PeriodicTask.sleep (   self)

virtual void sleep();

Definition at line 391 of file PeriodicTask.py.

◆ suspend()

def OpenRTM_aist.PeriodicTask.PeriodicTask.suspend (   self)

Suspending the task.

Suspending the task running.

virtual int suspend(void);

Definition at line 172 of file PeriodicTask.py.

◆ svc()

def OpenRTM_aist.PeriodicTask.PeriodicTask.svc (   self)

virtual int svc();

Definition at line 354 of file PeriodicTask.py.

◆ updateExecStat()

def OpenRTM_aist.PeriodicTask.PeriodicTask.updateExecStat (   self)

virtual void updateExecStat();

Definition at line 405 of file PeriodicTask.py.

◆ updatePeriodStat()

def OpenRTM_aist.PeriodicTask.PeriodicTask.updatePeriodStat (   self)

virtual void updatePeriodStat();

Definition at line 416 of file PeriodicTask.py.

Member Data Documentation

◆ _alive

OpenRTM_aist.PeriodicTask.PeriodicTask._alive
private

Definition at line 63 of file PeriodicTask.py.

◆ _deleteInDtor

OpenRTM_aist.PeriodicTask.PeriodicTask._deleteInDtor
private

Definition at line 62 of file PeriodicTask.py.

◆ _execCount

OpenRTM_aist.PeriodicTask.PeriodicTask._execCount
private

Definition at line 68 of file PeriodicTask.py.

◆ _execCountMax

OpenRTM_aist.PeriodicTask.PeriodicTask._execCountMax
private

Definition at line 69 of file PeriodicTask.py.

◆ _execMeasure

OpenRTM_aist.PeriodicTask.PeriodicTask._execMeasure
private

Definition at line 67 of file PeriodicTask.py.

◆ _execStat

OpenRTM_aist.PeriodicTask.PeriodicTask._execStat
private

Definition at line 70 of file PeriodicTask.py.

◆ _execTime

OpenRTM_aist.PeriodicTask.PeriodicTask._execTime
private

Definition at line 71 of file PeriodicTask.py.

◆ _func

OpenRTM_aist.PeriodicTask.PeriodicTask._func
private

Definition at line 61 of file PeriodicTask.py.

◆ _nowait

OpenRTM_aist.PeriodicTask.PeriodicTask._nowait
private

Definition at line 60 of file PeriodicTask.py.

◆ _period

OpenRTM_aist.PeriodicTask.PeriodicTask._period
private

Definition at line 59 of file PeriodicTask.py.

◆ _periodCount

OpenRTM_aist.PeriodicTask.PeriodicTask._periodCount
private

Definition at line 75 of file PeriodicTask.py.

◆ _periodCountMax

OpenRTM_aist.PeriodicTask.PeriodicTask._periodCountMax
private

Definition at line 76 of file PeriodicTask.py.

◆ _periodMeasure

OpenRTM_aist.PeriodicTask.PeriodicTask._periodMeasure
private

Definition at line 74 of file PeriodicTask.py.

◆ _periodStat

OpenRTM_aist.PeriodicTask.PeriodicTask._periodStat
private

Definition at line 77 of file PeriodicTask.py.

◆ _periodTime

OpenRTM_aist.PeriodicTask.PeriodicTask._periodTime
private

Definition at line 78 of file PeriodicTask.py.

◆ _suspend

OpenRTM_aist.PeriodicTask.PeriodicTask._suspend
private

Definition at line 64 of file PeriodicTask.py.


The documentation for this class was generated from the following file:


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:08