RtjAocsFramework.OperatingSystemObjects
Class DummyAocsClock

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

All Implemented Interfaces:

ActiveObject, AocsClock, Configurable, Resettable, Telemeterable

public class DummyAocsClock

extends AocsObject

implements AocsClock, ActiveObject

Dummy on-board clock useful for testing.

This class is not part of the AOCS Framework proper. Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

Field Summary

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

DummyAocsClock()

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 of the object.
int	getTime() Return the on-board time (unit of measure is application dependent).
boolean	initialize() Initialize an active object before it is scheduled.
void	reset() Bring the resettable state of the object to its initial default value.
void	runOneCycle(int deadline) Increment current cycle by 1 and the current time by 'dummyPeriod'
void	synchronizeWithSystemTime() Sychronize the local subsystem time with the system time.
boolean	terminate() Perfrom any shutdown actions before an active is de-scheduled.
void	writeToTelemetry(TelemetryStream tmStream) Direct 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

DummyAocsClock

public DummyAocsClock()

Method Detail

getClockPeriod

public int getClockPeriod()

Description copied from interface: AocsClock

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

Specified by:

getClockPeriod in interface AocsClock

getTime

public int getTime()

Description copied from interface: AocsClock

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

Specified by:

getTime in interface AocsClock

Overrides:

getTime in class AocsObject

getCycle

public int getCycle()

Description copied from interface: AocsClock

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()

Description copied from interface: AocsClock

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()

Description copied from interface: Resettable

Bring the resettable state of the object to its initial default value. A call to method reset on an object A is sometimes propagated to objects that are logically contained in A (relationship of strong aggregation).

Specified by:

reset in interface Resettable

Overrides:

reset in class AocsObject

getTelemetryImageLength

public int getTelemetryImageLength()

Description copied from interface: Telemeterable

Return the length (in bits) of the telemetry image of the object. This method is useful to verify that the quantity of data generated by a given object is compatible with the capacity of the telemetry channel.

Specified by:

getTelemetryImageLength in interface Telemeterable

Overrides:

getTelemetryImageLength in class AocsObject

writeToTelemetry

public void writeToTelemetry(TelemetryStream tmStream)

Description copied from interface: Telemeterable

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

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class AocsObject

runOneCycle

public void runOneCycle(int deadline)

Increment current cycle by 1 and the current time by 'dummyPeriod'

Specified by:

runOneCycle in interface ActiveObject

Parameters:

deadline - deadline by which the object must have returned. This parameter allows implementation of cooperative scheduling.

initialize

public boolean initialize()

Description copied from interface: ActiveObject

Initialize an active object before it is scheduled.

Specified by:

initialize in interface ActiveObject

Returns:

true if initialization was successful.

terminate

public boolean terminate()

Description copied from interface: ActiveObject

Perfrom any shutdown actions before an active is de-scheduled.

Specified by:

terminate in interface ActiveObject

Returns:

true if shutdown was successful.