keyType Class Reference

A class for handling keywords in dictionaries. More...

#include <OpenFOAM/keyType.H>

---

Detailed Description

A class for handling keywords in dictionaries.

A keyType is the keyword of a dictionary. It differs from word in that it accepts patterns (regular expressions).

Source files

• src/OpenFOAM/primitives/strings/keyType/keyType.H
• src/OpenFOAM/primitives/strings/keyType/keyType.C
• src/OpenFOAM/primitives/strings/keyType/keyTypeIO.C

Definition at line 58 of file keyType.H.

Inheritance diagram for keyType:

Collaboration diagram for keyType:

List of all members.

Public Member Functions
	keyType ()
	Construct null.
	keyType (const keyType &)
	Construct as copy.
	keyType (const word &)
	Construct as copy of word.
	keyType (const string &)
	Construct as copy of string. Expect it to be regular expression.
	keyType (const char *)
	Construct as copy of character array.
	keyType (const std::string &, const bool isPattern)
	Construct as copy of std::string.
	keyType (Istream &)
	Construct from Istream.
bool	isPattern () const
	Should be treated as a match rather than a literal string.
const keyType &	operator= (const keyType &)
const keyType &	operator= (const word &)
const keyType &	operator= (const string &)
	Assign from regular expression.
const keyType &	operator= (const char *)
Friends
Istream &	operator>> (Istream &, keyType &)
Ostream &	operator<< (Ostream &, const keyType &)

---

Constructor & Destructor Documentation

keyType

(

)

[inline]

Construct null.

Definition at line 32 of file keyTypeI.H.

keyType

(

const keyType &

s  )

[inline]

Construct as copy.

Definition at line 39 of file keyTypeI.H.

keyType

(

const word &

s  )

[inline]

Construct as copy of word.

Definition at line 46 of file keyTypeI.H.

keyType

(

const string &

s  )

[inline]

Construct as copy of string. Expect it to be regular expression.

Definition at line 54 of file keyTypeI.H.

keyType

(

const char *

s  )

[inline]

Construct as copy of character array.

Definition at line 62 of file keyTypeI.H.

keyType	(	const std::string &	s,
		const bool	isPattern
	)		[inline]

Construct as copy of std::string.

Definition at line 71 of file keyTypeI.H.

keyType

(

Istream &

is  )

Construct from Istream.

Definition at line 34 of file keyTypeIO.C.

---

Member Function Documentation

bool isPattern

(

)

const [inline]

Should be treated as a match rather than a literal string.

Definition at line 83 of file keyTypeI.H.

Referenced by dictionary::add(), dictionary::changeKeyword(), Ostream::write(), and Ostream::writeKeyword().

const Foam::keyType & operator=

(

const keyType &

s  )

[inline]

Definition at line 91 of file keyTypeI.H.

const Foam::keyType & operator=

(

const word &

s  )

[inline]

Reimplemented from word.

Definition at line 100 of file keyTypeI.H.

References word::operator=().

const Foam::keyType & operator=

(

const string &

s  )

[inline]

Assign from regular expression.

Reimplemented from word.

Definition at line 108 of file keyTypeI.H.

const Foam::keyType & operator=

(

const char *

s  )

[inline]

Reimplemented from word.

Definition at line 117 of file keyTypeI.H.

---

Friends And Related Function Documentation

Istream& operator>>	(	Istream &	,
		keyType &
	)		[friend]

Ostream& operator<<	(	Ostream &	,
		const keyType &
	)		[friend]

---

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

• src/OpenFOAM/primitives/strings/keyType/keyType.H
• src/OpenFOAM/primitives/strings/keyType/keyTypeI.H
• src/OpenFOAM/primitives/strings/keyType/keyTypeIO.C