jp.go.aist.rtm.RTC
Class PeriodicTaskBase

java.lang.Object
  java.lang.Thread
      jp.go.aist.rtm.RTC.PeriodicTaskBase

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

PeriodicTask

public abstract class PeriodicTaskBase
extends java.lang.Thread

Abstract class for task control

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

PeriodicTaskBase()

Method Summary

abstract void	_finalize() Finalizing the task
abstract int	_resume() Resuming the suspended task
abstract int	_suspend() Suspending the task
abstract void	activate() Starting the task
abstract void	executionMeasure(boolean value) Validate a Task execute time measurement
abstract void	executionMeasureCount(int n) Task execute time measurement period
abstract TimeMeasure.Statistics	getExecStat() Get a result in task execute time measurement
abstract TimeMeasure.Statistics	getPeriodStat() Get a result in task period time measurement
abstract void	periodicMeasure(boolean value) Validate a Task period time measurement
abstract void	periodicMeasureCount(int n) Task period time measurement count
abstract void	setPeriod(double period) Setting task execution period
abstract void	setPeriod(TimeValue period) Setting task execution period
abstract boolean	setTask(java.lang.Object obj) Setting task execution function
abstract boolean	setTask(java.lang.Object obj, boolean delete_in_dtor) Setting task execution function
abstract boolean	setTask(java.lang.Object obj, java.lang.String func) Setting task execution function
abstract boolean	setTask(java.lang.Object obj, java.lang.String func, boolean delete_in_dtor) Setting task execution function
abstract void	signal() Executing the suspended task one tick

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PeriodicTaskBase

public PeriodicTaskBase()

Method Detail

activate

public abstract void activate()

Starting the task

Pure virtual function for starting the task.

_finalize

public abstract void _finalize()

Finalizing the task

Pure virtual function for finalizing the task.

_suspend

public abstract int _suspend()

Suspending the task

Pure virtual function for suspending the task.

_resume

public abstract int _resume()

Resuming the suspended task

Pure virtual function for resuming the suspended task.

signal

public abstract void signal()

Executing the suspended task one tick

Pure virtual function for executing the suspended task one tick.

setTask

public abstract boolean setTask(java.lang.Object obj,
                                boolean delete_in_dtor)

Setting task execution function

Pure virtual function for setting task execution function.

Parameters:

obj - Object

delete_in_dtor - Delete flag.

setTask

public abstract boolean setTask(java.lang.Object obj)

Setting task execution function

Pure virtual function for setting task execution function.

Parameters:

obj - Object

setTask

public abstract boolean setTask(java.lang.Object obj,
                                java.lang.String func)

Setting task execution function

Pure virtual function for setting task execution function.

Parameters:

obj - Object

func - Function name

setTask

public abstract boolean setTask(java.lang.Object obj,
                                java.lang.String func,
                                boolean delete_in_dtor)

Setting task execution function

Pure virtual function for setting task execution function.

Parameters:

obj - Object

func - Function name

delete_in_dtor - Delete flag.

setPeriod

public abstract void setPeriod(double period)

Setting task execution period

Pure virtual function for setting task execution period.

Parameters:

period - Execution period.

setPeriod

public abstract void setPeriod(TimeValue period)

Setting task execution period

Pure virtual function for setting task execution period.

Parameters:

period - Execution period.

executionMeasure

public abstract void executionMeasure(boolean value)

Validate a Task execute time measurement

Pure virtual function for validate a Task execute time measurement.

Parameters:

value - flag(true: Valid, false: Invalid).

executionMeasureCount

public abstract void executionMeasureCount(int n)

Task execute time measurement period

Pure virtual function for task execute time measurement period.

Parameters:

n - Measurement period.

periodicMeasure

public abstract void periodicMeasure(boolean value)

Validate a Task period time measurement

Pure virtual function for validate a Task period time measurement.

Parameters:

value - flag(true: Valid, false: Invalid).

periodicMeasureCount

public abstract void periodicMeasureCount(int n)

Task period time measurement count

Pure virtual function for task period time measurement count.

Parameters:

n - Measurement period.

getExecStat

public abstract TimeMeasure.Statistics getExecStat()

Get a result in task execute time measurement

Pure virtual function for get a result in task execute time measurement.

Returns:

Statistics

getPeriodStat

public abstract TimeMeasure.Statistics getPeriodStat()

Get a result in task period time measurement

Pure virtual function for get a result in task period time measurement.

Returns:

Statistics