javax.realtime

Class PeriodicParameters

java.lang.Object

javax.realtime.ReleaseParameters

javax.realtime.PeriodicParameters

@SCJAllowed
public class PeriodicParameters
extends ReleaseParameters

This class is restricted relative to RTSJ so that it allows the start time and the period to be set but not changed or queried.

Version:

1.2; - December 2013

Author:

Anders P. Ravn, Aalborg University, apr@cs.aau.dk,
Hans Søndergaard, VIA University College, Denmark, hso@via.dk

Constructor Summary

Constructors

Constructor and Description
PeriodicParameters(RelativeTime start, RelativeTime period) Constructs a new object within the current memory area.
PeriodicParameters(RelativeTime start, RelativeTime period, RelativeTime deadline, AperiodicEventHandler missHandler) Constructs a new object within the current memory area.

Method Summary

Methods

Modifier and Type	Method and Description
RelativeTime	getPeriod()
RelativeTime	getStart()

Methods inherited from class javax.realtime.ReleaseParameters

getDeadline

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeriodicParameters

public PeriodicParameters(RelativeTime start,
                  RelativeTime period)

Constructs a new object within the current memory area. The default deadline is the same value as period.
There is no missHandler.

Parameters:

start - is the time of the first release relative to start of the mission. A null value defaults to a value of zero milliseconds.

period - is the is the time between each release of an associated schedulable object.

Throws:

java.lang.IllegalArgumentException - if period is null.

PeriodicParameters

@SCJAllowed(value=LEVEL_1)
public PeriodicParameters(RelativeTime start,
                                         RelativeTime period,
                                         RelativeTime deadline,
                                         AperiodicEventHandler missHandler)

Constructs a new object within the current memory area.

Parameters:

start - is time of the first release of the associated schedulable relative to the start of the mission. A null value defaults to zero milliseconds.

period - is the time between each release of the associated schedulable object.

deadline - is an offset from the release time by which the release should finish. A null deadline indicates the same value as the period.

missHandler - is the event handler to be released if the deadline is missed. A null value means that misses are not handled.

Throws:

java.lang.IllegalArgumentException - if period is null.

Method Detail

getPeriod

public RelativeTime getPeriod()

getStart

public RelativeTime getStart()