Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.SystemManagement
Interface Configurable

All Known Implementing Classes:
AocsEvent, AocsObject

public interface Configurable

Interface implemented by objects capable of being configured at run-time.

A configurable object is an object that is configured during the application initialization phase. The operations defined by the interface allow the configuration state to be checked and the configuration to be reset.

The configurable methods are intended for use during the initialization part only and are therefore not thread-safe.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz)
See Also:
The System Management Framelet Document.

Method Summary
 boolean isConfigured()
          Return false if some configuration data are missing.
 void resetConfiguration()
          Clear all configuration information.
 

Method Detail

resetConfiguration

public void resetConfiguration()
Clear all configuration information.

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


isConfigured

public boolean isConfigured()
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).


Real-Time Java AOCS Framework v1.0 API Specification

Real-Time Java AOCS Framework project home page

Automatic Control Laboratory, ETH Zuerich
Physikstrasse 3
CH-8092 Zuerich, Switzerland