RtjAocsFramework.AocsEvent
Class TelecommandEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--RtjAocsFramework.AocsEvent.AocsEvent
              |
              +--RtjAocsFramework.AocsEvent.TelecommandEvent

All Implemented Interfaces:

Configurable, Resettable, Serializable, Telemeterable

public class TelecommandEvent

extends AocsEvent

This class encapsulates a telecommand event. A telecommand event is generated in response to a telecommand being loaded and in response to a telecommand being executed.

Note that telecommand failures are reported as telecommand events, not as failure events. This choice reflects the fact that telecommand events are generated by the telecommand manager that has no knowledge of the cause of the telecommand failure.

This class adds adds to its parent class two attributes representing the telecommand identifier and its type.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

Telecommand, The Intercomponent Communication Document., Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

TelecommandEvent(Object dummySource)

Method Summary

short	getTelecommandId()
short	getTelecommandTypeId()
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
void	initialize(AocsObject creator, short evtType, short telecommandId, short telecommandTypeId) Initialize the telecommand event.
boolean	isConfigured() Return false if some configuration data are missing.
void	resetConfiguration() Clear all configuration information.
void	writeToTelemetry(TelemetryStream tmStream) Direct the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.AocsEvent.AocsEvent

getCreator, getEventType, getTelemetryFormat, getTimeStamp, initialize, reset, setTelemetryFormat

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TelecommandEvent

public TelecommandEvent(Object dummySource)

Method Detail

initialize

public void initialize(AocsObject creator,
                       short evtType,
                       short telecommandId,
                       short telecommandTypeId)

Initialize the telecommand event.

The creator and evtType parameters are the same as in the initialize method in the super class AocsEvent. The telecommand parameter is the telecommand whose loading or execution occasioned the generation of the event.

See Also:

AocsEvent.initialize(RtjAocsFramework.BasicObjects.AocsObject, short)

getTelecommandId

public short getTelecommandId()

getTelecommandTypeId

public short getTelecommandTypeId()

resetConfiguration

public void resetConfiguration()

Description copied from interface: Configurable

Clear all configuration information.

Calls to resetConfiguration are propagated to objects that are in a relationship of strong aggregation.

Specified by:

resetConfiguration in interface Configurable

Overrides:

resetConfiguration in class AocsEvent

isConfigured

public boolean isConfigured()

Description copied from interface: Configurable

Return false if some configuration data are missing.

Typically, a false value indicates that a plug-in component is missing or that the object has not been initialized. This is a negative check only: a return value of true cannot guarantee that the object is correctly configured.

Calls to resetConfiguration on an object A are normally not propagated objects of type AocsObject that are contained or otherwise aggregated to A. The rationale for this policy is that all objects of type AocsObject implement interface configurable and therefore their configuration status should be checked externally (probably through the configuration check service of the system manager).

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class AocsEvent

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 AocsEvent

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 AocsEvent