.TH "sc::ParsedKeyVal" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::ParsedKeyVal \- Converts textual information into keyword/value assocations\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <keyval\&.h>\fP
.PP
Inherits \fBsc::StringKeyVal\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBParsedKeyVal\fP ()"
.br
.RI "Create an empty \fBParsedKeyVal\fP\&. "
.ti -1c
.RI "\fBParsedKeyVal\fP (const char *file)"
.br
.RI "Parse the given input file\&. "
.ti -1c
.RI "\fBParsedKeyVal\fP (std::istream &s)"
.br
.RI "Read input from s\&. "
.ti -1c
.RI "\fBParsedKeyVal\fP (\fBIPV2\fP *)"
.br
.RI "Use the given IPV2* object\&. "
.ti -1c
.RI "\fBParsedKeyVal\fP (const char *, const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.RI "This ctor is given a string which is used to form keywords that are sought in the keyval argument\&. "
.ti -1c
.RI "\fB~ParsedKeyVal\fP ()"
.br
.RI "Cleanup, deleting the \fBIPV2\fP object\&. "
.ti -1c
.RI "void \fBread\fP (const char *)"
.br
.RI "Read input data from the given filename\&. "
.ti -1c
.RI "void \fBread\fP (std::istream &)"
.br
.RI "Read input data from the given stream\&. "
.ti -1c
.RI "void \fBparse_string\fP (const char *)"
.br
.RI "Read input data from the given string\&. "
.in -1c
.PP
.RI "\fBOverrides of parent members\&.\fP"
.br
See parent class documentation\&. 
.PP
.in +1c
.in +1c
.ti -1c
.RI "const char * \fBstringrep\fP (const char *)"
.br
.RI "Returns the string representation of the value assigned to key\&. "
.ti -1c
.RI "const char * \fBclassname\fP (const char *)"
.br
.RI "Returns the name of the exact class of the object at the keyword\&. "
.ti -1c
.RI "const char * \fBtruekeyword\fP (const char *)"
.br
.RI "Returns a string which is the actual keyword if some sort of variable substitution takes place (needed to make multiple references to the same object work in input files)\&. "
.ti -1c
.RI "void \fBerrortrace\fP (std::ostream &fp=\fBExEnv::err0\fP())"
.br
.RI "Write a message to fp describing the error\&. "
.ti -1c
.RI "void \fBdump\fP (std::ostream &fp=\fBExEnv::err0\fP())"
.br
.RI "Write a message to fp describing the error\&. "
.ti -1c
.RI "void \fBprint_unseen\fP (std::ostream &fp=\fBExEnv::out0\fP())"
.br
.RI "Print keywords that were never looked at, if possible\&. "
.ti -1c
.RI "int \fBhave_unseen\fP ()"
.br
.RI "Return 1 if there were unseen keywords, 0 if there are none, or -1 this keyval doesn't keep track of unseen keywords\&. "
.in -1c
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBcat_files\fP (const char *, const \fBRef\fP< \fBKeyVal\fP > &, std::ostream &o)"
.br
.RI "This is like the \fBParsedKeyVal(const char*,const Ref<KeyVal>&)\fP ctor, but writes the contents of the files to the given ostream\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
Converts textual information into keyword/value assocations\&. 

The parsing is done with an \fBIPV2\fP object\&. The \fBkeyval\fP for more information on the input format\&. 
.br
 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::ParsedKeyVal::ParsedKeyVal (\fBIPV2\fP *)"

.PP
Use the given IPV2* object\&. The new \fBParsedKeyVal\fP takes wnership of the passed \fBIPV2\fP object\&. 
.SS "sc::ParsedKeyVal::ParsedKeyVal (const char *, const \fBRef\fP< \fBKeyVal\fP > &)"

.PP
This ctor is given a string which is used to form keywords that are sought in the keyval argument\&. The associated values are used to construct file names that are used to initialize the \fBParsedKeyVal\fP\&. The keywords sought are string'dir' for the directory prefix and string'files' for an array of file names\&. 
.SH "Member Function Documentation"
.PP 
.SS "const char* sc::ParsedKeyVal::classname (const char *)\fC [virtual]\fP"

.PP
Returns the name of the exact class of the object at the keyword\&. If no classname is assigned then 0 is returned\&. 
.PP
Reimplemented from \fBsc::StringKeyVal\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.