RtjAocsFramework.OperatingSystemObjects
Interface AocsClock

All Known Implementing Classes:

DummyAocsClock, JbedSmmClock, TestSmmClock

public interface AocsClock

Interface characterizing the on-board source of timing reference.

An object that implements AocsClock is capable of providing the on-board time.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

Method Summary

int	getClockPeriod() Return the clock period in case on-board time is updated periodically, otherwise return zero.
int	getCycle() Return the current cycle number.
int	getTime() Return the on-board time (unit of measure is application dependent).
void	synchronizeWithSystemTime() Sychronize the local subsystem time with the system time.

Method Detail

getTime

public int getTime()

Return the on-board time (unit of measure is application dependent).

getClockPeriod

public int getClockPeriod()

Return the clock period in case on-board time is updated periodically, otherwise return zero.

getCycle

public int getCycle()

Return the current cycle number.

It is assumed that the software executes cyclically. This method returns the current cycle number counted from the last software reset.

synchronizeWithSystemTime

public void synchronizeWithSystemTime()

Sychronize the local subsystem time with the system time.

Some applications may have different timing sources for different subsystems. If a central system time exists, a call to this method will cause the local time to be synchronized to the system time.