MPQC 2.3.1

- Main Page
- Related Pages
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions
sc::ParsedKeyVal Class Reference

Converts textual information into keyword/value assocations. More...

`#include <keyval.h>`

Inheritance diagram for sc::ParsedKeyVal:

List of all members.

## Public Member Functions

| ParsedKeyVal ()
| Create an empty ParsedKeyVal.
| ParsedKeyVal (const char *file)
| Parse the given input file.
| ParsedKeyVal (std::istream &s)
| Read input from s.
| ParsedKeyVal (IPV2 *)
| Use the given IPV2* object.
| ParsedKeyVal (const char *, const Ref< KeyVal > &)
| This ctor is given a string which is used to form keywords that are sought in the keyval argument.
| ~ParsedKeyVal ()
| Cleanup, deleting the IPV2 object.
void | read (const char *)
| Read input data from the given filename.
void | read (std::istream &)
| Read input data from the given stream.
void | parse_string (const char *)
| Read input data from the given string.
Overrides of parent members.
See parent class documentation.
const char * | stringrep (const char *)
| Returns the string representation of the value assigned to key.
const char * | classname (const char *)
| Returns the name of the exact class of the object at the keyword.
const char * | truekeyword (const char *)
| 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).
void | errortrace (std::ostream &fp=ExEnv::err0())
| Write a message to fp describing the error.
void | dump (std::ostream &fp=ExEnv::err0())
| Write a message to fp describing the error.
void | print_unseen (std::ostream &fp=ExEnv::out0())
| Print keywords that were never looked at, if possible.
int | have_unseen ()
| Return 1 if there were unseen keywords, 0 if there are none, or -1 this keyval doesn't keep track of unseen keywords.

## Static Public Member Functions

static void | cat_files (const char *, const Ref< KeyVal > &, std::ostream &o)
| This is like the ParsedKeyVal(const char*,const Ref<KeyVal>&) ctor, but writes the contents of the files to the given ostream.

## Detailed Description

Converts textual information into keyword/value assocations.

The parsing is done with an IPV2 object. The The KeyVal Library for more information on the input format.

## Constructor & Destructor Documentation

sc::ParsedKeyVal::ParsedKeyVal | ( | IPV2 * |  | ) |

Use the given IPV2* object.

The new ParsedKeyVal takes wnership of the passed IPV2 object.

sc::ParsedKeyVal::ParsedKeyVal | ( | const char * | ,
|  | const Ref< KeyVal > & |
| ) |  |

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 ParsedKeyVal. The keywords sought are string'dir' for the directory prefix and string'files' for an array of file names.

## Member Function Documentation

static void sc::ParsedKeyVal::cat_files | ( | const char * | ,
|  | const Ref< KeyVal > & | ,
|  | std::ostream & | o
| ) |  | `[static]`

This is like the ParsedKeyVal(const char*,const Ref<KeyVal>&) ctor, but writes the contents of the files to the given ostream.

const char* sc::ParsedKeyVal::classname | ( | const char * |  | ) | `[virtual]`

Returns the name of the exact class of the object at the keyword.

If no classname is assigned then 0 is returned.

Reimplemented from sc::StringKeyVal.

int sc::ParsedKeyVal::have_unseen | ( |  | ) | `[virtual]`

Return 1 if there were unseen keywords, 0 if there are none, or -1 this keyval doesn't keep track of unseen keywords.

Reimplemented from sc::KeyVal.

const char* sc::ParsedKeyVal::truekeyword | ( | const char * |  | ) | `[virtual]`

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).

Reimplemented from sc::StringKeyVal.

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

- keyval.h