JbedSmmApplication.OperatingSystemObjects
Class JbedSmmClock

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--JbedSmmApplication.OperatingSystemObjects.JbedSmmClock

All Implemented Interfaces:

AocsClock, Configurable, Resettable, Telemeterable

public class JbedSmmClock

extends AocsObject

implements AocsClock

A system time component for the SMM application deployed on Jbed RTOS. The component offers a method for acquisition of the system time, clock period, and clock cycle.

Change Record:

• Version 1.1: removed call to System.time from the constructor to permit instantiation in environments where the Jbed library is not available. This required a modification of the semantic of method getTime.

Copyright: See the Copyright Notice.

Version:

1.1

Author:

V. Cechticky/A. Pasetti (ETH-Zurich)

Field Summary

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

JbedSmmClock()
Default constructor

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	getTelemetryImageLength() Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.
int	getTime() Return the on-board time (unit of measure is application dependent).
void	reset() Reset super object state and performs a local reset.
void	synchronizeWithSystemTime() Sychronize the local subsystem time with the system time.
void	writeToTelemetry(TelemetryStream stream) Causes the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject

addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, isConfigured, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetConfiguration, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat

Methods inherited from class RtjAocsFramework.BasicObjects.RootObject

getClassId, getInstanceId, setClassId

Methods inherited from class java.lang.Object

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

Constructor Detail

JbedSmmClock

public JbedSmmClock()

Default constructor

Method Detail

getTime

public int getTime()

Return the on-board time (unit of measure is application dependent). This method always returns zero the first time it is called after the component is created or reset. Afterwards, it returns the time in millisecond elapsed from the first call.

Specified by:

getTime in interface AocsClock

Overrides:

getTime in class AocsObject

getClockPeriod

public int getClockPeriod()

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

Specified by:

getClockPeriod in interface AocsClock

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.

Specified by:

getCycle in interface AocsClock

Overrides:

getCycle in class AocsObject

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.

Specified by:

synchronizeWithSystemTime in interface AocsClock

reset

public void reset()

Reset super object state and performs a local reset.

Specified by:

reset in interface Resettable

Overrides:

reset in class AocsObject

getTelemetryImageLength

public int getTelemetryImageLength()

Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.

Specified by:

getTelemetryImageLength in interface Telemeterable

Overrides:

getTelemetryImageLength in class AocsObject

Returns:

the length in bits of the telemetry image

writeToTelemetry

public void writeToTelemetry(TelemetryStream stream)

Causes the object to write its own state to the telemetry stream.

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class AocsObject

Parameters:

stream - the telemetry stream