LOCA::Parameter::SublistParser Class Reference
Class to parse a parameter list for sublists. More...
#include <LOCA_Parameter_SublistParser.H>
Public Member Functions | |
| SublistParser (const Teuchos::RCP< LOCA::GlobalData > &global_data) | |
| Constructor. | |
| ~SublistParser () | |
| Destructor. | |
| void | parseSublists (const Teuchos::RCP< Teuchos::ParameterList > &topLevelParams) |
| Parse parameter list to find sublists. | |
| Teuchos::RCP < Teuchos::ParameterList > | getSublist (const string &name) |
Return sublist of name name. | |
Protected Attributes | |
| Teuchos::RCP< LOCA::GlobalData > | globalData |
| Global data. | |
| SublistMap | sublistMap |
| Map to hold sublists. | |
Private Types | |
| typedef map< string, Teuchos::RCP < Teuchos::ParameterList > > | SublistMap |
| Map type to hold sublists. | |
| typedef SublistMap::iterator | SublistMapIterator |
| Iterator type to traverse SublistMap. | |
Private Member Functions | |
| SublistParser (const SublistParser &) | |
| Private to prohibit copying. | |
| SublistParser & | operator= (const SublistParser &) |
| Private to prohibit copying. | |
Detailed Description
Class to parse a parameter list for sublists.This class parses a supplied parameter list and locates various sublists. This saves the code from having to traverse the parameter list to find sublists itself, and puts in one location the hard-coded structure of the parameter list.
Definition at line 68 of file LOCA_Parameter_SublistParser.H.
Member Typedef Documentation
typedef map<string, Teuchos::RCP<Teuchos::ParameterList> > LOCA::Parameter::SublistParser::SublistMap [private] |
typedef SublistMap::iterator LOCA::Parameter::SublistParser::SublistMapIterator [private] |
Constructor & Destructor Documentation
| LOCA::Parameter::SublistParser::SublistParser | ( | const Teuchos::RCP< LOCA::GlobalData > & | global_data | ) |
| LOCA::Parameter::SublistParser::~SublistParser | ( | ) |
| LOCA::Parameter::SublistParser::SublistParser | ( | const SublistParser & | ) | [private] |
Private to prohibit copying.
Member Function Documentation
| void LOCA::Parameter::SublistParser::parseSublists | ( | const Teuchos::RCP< Teuchos::ParameterList > & | topLevelParams | ) |
Parse parameter list to find sublists.
Definition at line 59 of file LOCA_Parameter_SublistParser.C.
References sublistMap.
| Teuchos::RCP< Teuchos::ParameterList > LOCA::Parameter::SublistParser::getSublist | ( | const string & | name | ) |
Return sublist of name name.
Definition at line 133 of file LOCA_Parameter_SublistParser.C.
References globalData, and sublistMap.
| SublistParser& LOCA::Parameter::SublistParser::operator= | ( | const SublistParser & | ) | [private] |
Private to prohibit copying.
Member Data Documentation
Teuchos::RCP<LOCA::GlobalData> LOCA::Parameter::SublistParser::globalData [protected] |
Global data.
Definition at line 104 of file LOCA_Parameter_SublistParser.H.
Referenced by getSublist().
SublistMap LOCA::Parameter::SublistParser::sublistMap [protected] |
Map to hold sublists.
Definition at line 107 of file LOCA_Parameter_SublistParser.H.
Referenced by getSublist(), and parseSublists().
The documentation for this class was generated from the following files:
