.TH "sc::StringKeyVal" 3 "Fri Dec 2 2022" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::StringKeyVal \- \fBStringKeyVal\fP is a base class for \fBKeyVal\fP implementations that store all values in a string format\&.  

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

.in +1c
.ti -1c
.RI "virtual const char * \fBstringrep\fP (const char *key)=0"
.br
.RI "Returns the string representation of the value assigned to key\&. "
.ti -1c
.RI "virtual const char * \fBclassname\fP (const char *)"
.br
.RI "Returns the name of the exact class of the object at the keyword\&. "
.ti -1c
.RI "virtual 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)\&. "
.in -1c
.PP
.RI "\fBDebugging\&.\fP"
.br
See the parent class documentation for descriptions of these functions\&. 
.PP
.in +1c
.in +1c
.ti -1c
.RI "virtual void \fBerrortrace\fP (std::ostream &fp=\fBExEnv::err0\fP())"
.br
.RI "Write a message to fp describing the error\&. "
.ti -1c
.RI "virtual void \fBdump\fP (std::ostream &fp=\fBExEnv::err0\fP())"
.br
.RI "Write a message to fp describing the error\&. "
.in -1c
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "int \fBkey_exists\fP (const char *)"
.br
.RI "Ultimately called by exists\&. "
.ti -1c
.RI "\fBRef\fP< \fBKeyValValue\fP > \fBkey_value\fP (const char *, const \fBKeyValValue\fP &def)"
.br
.RI "Ultimately called by value\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
\fBStringKeyVal\fP is a base class for \fBKeyVal\fP implementations that store all values in a string format\&. 

These are converted to other data types through \fBKeyValValue\fP\&. 
.SH "Member Function Documentation"
.PP 
.SS "virtual const char * sc::StringKeyVal::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 in \fBsc::ParsedKeyVal\fP\&.
.SS "virtual void sc::StringKeyVal::dump (std::ostream & fp = \fC\fBExEnv::err0\fP()\fP)\fC [virtual]\fP"

.PP
Write a message to fp describing the error\&. 
.PP
Reimplemented from \fBsc::KeyVal\fP\&.
.PP
Reimplemented in \fBsc::ParsedKeyVal\fP\&.
.SS "virtual void sc::StringKeyVal::errortrace (std::ostream & fp = \fC\fBExEnv::err0\fP()\fP)\fC [virtual]\fP"

.PP
Write a message to fp describing the error\&. 
.PP
Reimplemented from \fBsc::KeyVal\fP\&.
.PP
Reimplemented in \fBsc::ParsedKeyVal\fP\&.
.SS "int sc::StringKeyVal::key_exists (const char *)\fC [protected]\fP, \fC [virtual]\fP"

.PP
Ultimately called by exists\&. 
.PP
Implements \fBsc::KeyVal\fP\&.
.SS "\fBRef\fP< \fBKeyValValue\fP > sc::StringKeyVal::key_value (const char *, const \fBKeyValValue\fP & def)\fC [protected]\fP, \fC [virtual]\fP"

.PP
Ultimately called by value\&. 
.PP
Implements \fBsc::KeyVal\fP\&.
.SS "virtual const char * sc::StringKeyVal::stringrep (const char * key)\fC [pure virtual]\fP"

.PP
Returns the string representation of the value assigned to key\&. 
.PP
Implemented in \fBsc::ParsedKeyVal\fP\&.
.SS "virtual const char * sc::StringKeyVal::truekeyword (const char *)\fC [virtual]\fP"

.PP
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)\&. 
.PP
Reimplemented in \fBsc::ParsedKeyVal\fP\&.

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