Dxc::SystemCatalog Class Reference

System Catalog parser. More...

#include </home/user/DXC_svn/trunk/Src/APIs/cpp/DataTypes/SystemCatalog.hpp>

List of all members.

Public Member Functions

const std::string getSystemName () const
 The name of the system.
const std::set< std::string > * getComponentIDs () const
 The set of component IDs the system contains.
const std::set< std::string > * getFaultModeIDs (const std::string &componentID) const
 The set of mode IDs of a given component.
const std::map< std::string,
double > * 
getSensorsAndCosts () const
 A map of sensors and their probing cost, if any.
bool isComponentValid (const std::string &componentID) const
 Test the validity of a componentID.
bool isFaultModeValid (const std::string &componentID, const std::string &modeID) const
 Given a valid component, test the validity of a mode ID.

Static Public Member Functions

static const SystemCataloggetInstance (const std::string &system)
 Get a system's catalog.

Detailed Description

System Catalog parser.

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


Member Function Documentation

const set< string > * SystemCatalog::getFaultModeIDs ( const std::string &  componentID  )  const

The set of mode IDs of a given component.

Parameters:
componentID - component's ID
static const SystemCatalog* Dxc::SystemCatalog::getInstance ( const std::string &  system  )  [static]

Get a system's catalog.

Parameters:
system - the system's name

System catalogs are searched for in $DXC_HOME/[SYSTEMCAT_DIR] (see DXC.cfg for SYSTEMCAT_DIR).

bool Dxc::SystemCatalog::isComponentValid ( const std::string &  componentID  )  const

Test the validity of a componentID.

Parameters:
componentID - component's ID
bool Dxc::SystemCatalog::isFaultModeValid ( const std::string &  componentID,
const std::string &  modeID 
) const

Given a valid component, test the validity of a mode ID.

Parameters:
componentID - component ID
modeID - mode ID

The documentation for this class was generated from the following files:

Generated on 22 Feb 2013 for dxcApi by  doxygen 1.6.1