org.dxc.api.datatypes
Interface SystemCatalog

All Known Implementing Classes:
SystemCatalogXML

public interface SystemCatalog

System catalog parser. Provides a data structure for accessing information contained in a system's XML catalog.


Method Summary
 Set<String> getComponentIDs()
          The set of component IDs the system contains.
 Set<String> getFaultModes(String componentID)
          The set of mode IDs of a given component
 Set<String> getModes(String componentID)
          The set of mode IDs of a given component
 int getNumFaultModes()
          Returns the number of total component fault modes
 int getNumModes()
          Returns the number of total component modes
 int getNumNoFaultComponents()
          Returns the number of components with no fault modes
 Map<String,Double> getSensorsAndCosts()
          A map of the system's sensors and their probing cost, if any
 String getSystemName()
          The name of the system.
 boolean isComponentValid(String componentID)
          Test the validity of a componentID.
 boolean isFaultModeValid(Fault f)
           
 boolean isFaultModeValid(String componentID, String modeID)
          Given a valid component, test the validity of a mode ID.
 boolean isModeValid(String componentID, String modeID)
          Given a valid component, test the validity of a mode ID.
 

Method Detail

getSystemName

String getSystemName()
The name of the system.


getComponentIDs

Set<String> getComponentIDs()
The set of component IDs the system contains.


getModes

Set<String> getModes(String componentID)
The set of mode IDs of a given component

Parameters:
componentID - component's ID

getFaultModes

Set<String> getFaultModes(String componentID)
The set of mode IDs of a given component

Parameters:
componentID - component's ID

getSensorsAndCosts

Map<String,Double> getSensorsAndCosts()
A map of the system's sensors and their probing cost, if any


isComponentValid

boolean isComponentValid(String componentID)
Test the validity of a componentID.

Parameters:
componentID - component's ID

isModeValid

boolean isModeValid(String componentID,
                    String modeID)
Given a valid component, test the validity of a mode ID.

Parameters:
componentID - component ID
modeID - mode ID

isFaultModeValid

boolean isFaultModeValid(String componentID,
                         String modeID)
Given a valid component, test the validity of a mode ID.

Parameters:
componentID - component ID
modeID - mode ID

getNumModes

int getNumModes()
Returns the number of total component modes


getNumFaultModes

int getNumFaultModes()
Returns the number of total component fault modes


getNumNoFaultComponents

int getNumNoFaultComponents()
Returns the number of components with no fault modes


isFaultModeValid

boolean isFaultModeValid(Fault f)