|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Objectorg.dxc.api.datatypes.SystemCatalogXML
public class SystemCatalogXML
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 |
static SystemCatalog |
getInstance(String system)
Get a system's catalog. |
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)
Test the validity of a Fault. |
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. |
Methods inherited from class Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static SystemCatalog getInstance(String system) throws Exception
system
- the system's name
System catalogs are searched for in $DXC_HOME/[SYSTEMCAT_DIR]
(see DXC.cfg for SYSTEMCAT_DIR).
Exception
public String getSystemName()
getSystemName
in interface SystemCatalog
public Set<String> getComponentIDs()
getComponentIDs
in interface SystemCatalog
public Set<String> getModes(String componentID)
SystemCatalog
getModes
in interface SystemCatalog
componentID
- component's IDpublic Set<String> getFaultModes(String componentID)
getFaultModes
in interface SystemCatalog
componentID
- component's IDpublic boolean isComponentValid(String componentID)
isComponentValid
in interface SystemCatalog
componentID
- component's IDpublic boolean isModeValid(String componentID, String modeID)
SystemCatalog
isModeValid
in interface SystemCatalog
componentID
- component IDmodeID
- mode IDpublic boolean isFaultModeValid(String componentID, String modeID)
isFaultModeValid
in interface SystemCatalog
componentID
- component IDmodeID
- mode IDpublic boolean isFaultModeValid(Fault f)
isFaultModeValid
in interface SystemCatalog
public int getNumModes()
SystemCatalog
getNumModes
in interface SystemCatalog
public int getNumFaultModes()
SystemCatalog
getNumFaultModes
in interface SystemCatalog
public int getNumNoFaultComponents()
SystemCatalog
getNumNoFaultComponents
in interface SystemCatalog
public Map<String,Double> getSensorsAndCosts()
SystemCatalog
getSensorsAndCosts
in interface SystemCatalog
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |