A class for handling words, derived from string. More...

Inheritance diagram for word:

[legend]

Collaboration diagram for word:

Public Member Functions
	word ()
	Construct null. More...

	word (const word &)
	Copy constructor. More...

	word (const char *, const bool doStripInvalid=true)
	Copy constructor of character array. More...

	word (const char *, const size_type, const bool doStripInvalid)
	Copy constructor with a maximum number of characters. More...

	word (const string &, const bool doStripInvalid=true)
	Copy constructor of string. More...

	word (const std::string &, const bool doStripInvalid=true)
	Copy constructor of std::string. More...

	word (Istream &)
	Construct from Istream. More...

word	capitalise () const
	Return the word with the first letter capitalised. More...

void	operator= (const word &)

void	operator= (const string &)

void	operator= (const std::string &)

void	operator= (const char *)

Public Member Functions inherited from string
	string ()
	Construct null. More...

	string (const std::string &)
	Construct from std::string. More...

	string (const string &)
	Copy constructor. More...

	string (string &&)
	Move constructor. More...

	string (const char *)
	Construct as copy of character array. More...

	string (const UList< char > &)
	Construct as copy of UList of character. More...

	string (const char *, const size_type)
	Construct as copy of specified number of characters. More...

	string (const char)
	Construct from a single character. More...

	string (const size_type, const char)
	Construct from copies of a single character. More...

	string (Istream &)
	Construct from Istream. More...

size_type	count (const char) const
	Count and return the number of a given character in the string. More...

bool	match (const std::string &) const
	True when strings match literally. More...

string &	replace (const string &oldStr, const string &newStr, size_type start=0)
	In this string replace first occurrence of sub-string oldStr. More...

string	replace (const string &oldStr, const string &newStr, size_type start=0) const
	Replace first occurrence of sub-string oldStr with newStr. More...

string &	replaceAll (const string &oldStr, const string &newStr, size_type start=0)
	In this string replace all occurrences of sub-string oldStr. More...

string	replaceAll (const string &oldStr, const string &newStr, size_type start=0) const
	Replace all occurrences of sub-string oldStr with newStr. More...

string &	expand (const bool allowEmpty=false)
	Expand initial tildes and all occurrences of environment variables. More...

bool	removeRepeated (const char)
	Remove repeated characters returning true if string changed. More...

string	removeRepeated (const char) const
	Return string with repeated characters removed. More...

bool	removeTrailing (const char)
	Remove trailing character returning true if string changed. More...

string	removeTrailing (const char) const
	Return string with trailing character removed. More...

bool	removeTrailing (const string &)
	Remove trailing string returning true if string changed. More...

string	removeTrailing (const string &) const
	Return string with trailing string removed. More...

void	strip (const string &)
	Strip characters from the start and end of the string. More...

string	operator() (const size_type i, const size_type n) const
	Return the sub-string from the i-th character for n characters. More...

string	operator() (const size_type n) const
	Return the sub-string from the first character for n characters. More...

void	operator= (const string &)

void	operator= (string &&)

template<class String >
Foam::string	quotemeta (const string &str, const char quote)

Static Public Member Functions
static bool	valid (char)
	Is this character valid for a word. More...

Static Public Member Functions inherited from string
template<class String >
static bool	valid (const string &)
	Is this string type valid? More...

template<class String >
static bool	meta (const string &, const char quote='\\')
	Does this string have particular meta-characters? More...

template<class String >
static bool	stripInvalid (string &)
	Strip invalid characters from the given string. More...

template<class String >
static String	validate (const string &)
	Return a valid String from the given string. More...

template<class String >
static string	quotemeta (const string &, const char quote='\\')
	Return a String with quoted meta-characters from the given string. More...

Static Public Attributes
static const char *const	typeName = "word"

static int	debug

static const word	null
	An empty word. More...

Static Public Attributes inherited from string
static const char *const	typeName = "string"

static int	debug

static const string	null
	An empty string. More...

Friends
word	operator & (const word &, const word &)

Istream &	operator>> (Istream &, word &)

Ostream &	operator<< (Ostream &, const word &)

Detailed Description

A class for handling words, derived from string.

A word is a string of characters without whitespace, quotes, slashes, semicolons or brace brackets. Words are delimited by whitespace.

Source files

Definition at line 59 of file word.H.

Constructor & Destructor Documentation

◆ word() [1/7]

word ( )

inline

Construct null.

Definition at line 59 of file wordI.H.

Referenced by word::word().

Here is the caller graph for this function:

◆ word() [2/7]

word ( const word & w )

inline

Copy constructor.

Definition at line 53 of file wordI.H.

◆ word() [3/7]

word	(	const char *	s,
		const bool	doStripInvalid = `true`
	)

inline

Copy constructor of character array.

Definition at line 87 of file wordI.H.

References word::word().

Here is the call graph for this function:

◆ word() [4/7]

word	(	const char *	s,
		const size_type	n,
		const bool	doStripInvalid
	)

inline

Copy constructor with a maximum number of characters.

Definition at line 98 of file wordI.H.

◆ word() [5/7]

word	(	const string &	s,
		const bool	doStripInvalid = `true`
	)

inline

Copy constructor of string.

Definition at line 65 of file wordI.H.

◆ word() [6/7]

word	(	const std::string &	s,
		const bool	doStripInvalid = `true`
	)

inline

Copy constructor of std::string.

Definition at line 76 of file wordI.H.

◆ word() [7/7]

word ( Istream & is )

Construct from Istream.

Definition at line 31 of file wordIO.C.

Member Function Documentation

◆ valid()

bool valid ( char c )

inlinestatic

Is this character valid for a word.

Definition at line 115 of file wordI.H.

References Foam::isspace().

Referenced by cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), and ISstream::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ capitalise()

Foam::word capitalise ( ) const

inline

Return the word with the first letter capitalised.

Definition at line 131 of file wordI.H.

◆ operator=() [1/4]

void operator= ( const word & q )

inline

Definition at line 141 of file wordI.H.

References string::operator=().

Referenced by functionName::operator=(), keyType::operator=(), and wordRe::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/4]

void operator= ( const string & q )

inline

Definition at line 147 of file wordI.H.

References string::operator=().

Here is the call graph for this function:

◆ operator=() [3/4]

void operator= ( const std::string & q )

inline

Definition at line 154 of file wordI.H.

References string::operator=().

Here is the call graph for this function:

◆ operator=() [4/4]

void operator= ( const char * q )

inline

Definition at line 161 of file wordI.H.

References Foam::constant::physicoChemical::b, Foam::operator &(), and string::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator &

word operator&	(	const word &	,
		const word &
	)

friend

◆ operator>>

Istream& operator>>	(	Istream &	,
		word &
	)

friend

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const word &
	)

friend

Member Data Documentation

◆ typeName

const char *const typeName = "word"

static

Definition at line 73 of file word.H.

Referenced by token::wordToken().

◆ debug

int debug

static

Definition at line 74 of file word.H.

Referenced by wordRe::uncompile().

◆ null

const Foam::word null

static

An empty word.

Definition at line 77 of file word.H.

Referenced by surfaceZonesInfo::addCellZonesToMesh(), forces::alpha(), limitTemperature::constrainedFields(), Maxwell< BasicMomentumTransportModel >::correct(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), forces::devTau(), fileOperation::exists(), masterUncollatedFileOperation::exists(), fileName::ext(), masterUncollatedFileOperation::filePathInfo(), functionObjectList::findDict(), boundaryRegion::findIndex(), cellTable::findIndex(), Time::findInstancePath(), masterUncollatedFileOperation::findInstancePath(), IOobject::group(), IOobject::groupName(), basicThermo::heBoundaryBaseTypes(), Foam::interpolate(), Foam::triIntersect::intersectTris(), meshToMesh::mapAndOpTgtToSrc(), IOobject::modelName(), MRFZone::MRFZone(), forces::mu(), functionObjectList::New(), collatedFileOperation::objectPath(), porosityModel::iNew::operator()(), patchInternalField::patchInternalField(), basicThermo::phasePropertyName(), phaseScalarTransport::phaseScalarTransport(), coordSet::pointName(), polyPatch::polyPatch(), porosityModel::porosityModel(), Qdot::read(), shearStress::read(), totalEnthalpy::read(), decomposedBlockData::read(), wallHeatFlux::read(), wallShearStress::read(), turbulenceFields::read(), forces::read(), functionObjectList::readFunctionObject(), fileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), Foam::regionDir(), nonConformalCoupledPolyPatch::rename(), nonConformalCoupledPolyPatch::reorder(), Time::runTimeModifiable(), coordSet::scalarName(), phaseInterface::separator(), sampledSet::setSamples(), intersection::srcBoxStatic(), dictionary::topDictKeyword(), flowRateInletVelocityFvPatchVectorField::updateCoeffs(), externalWallHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), token::wordToken(), gnuplotSetWriter::write(), surfaceSlipDisplacementPointPatchVectorField::write(), surfaceDisplacementPointPatchVectorField::write(), layerAverage::write(), flowRateInletVelocityFvPatchVectorField::write(), streamlines::write(), externalWallHeatFluxTemperatureFvPatchScalarField::write(), and Foam::writeMeshObject().

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

src/OpenFOAM/primitives/strings/word/word.H
src/OpenFOAM/primitives/strings/word/word.C
src/OpenFOAM/primitives/strings/word/wordI.H
src/OpenFOAM/primitives/strings/word/wordIO.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ word() [1/7]

◆ word() [2/7]

◆ word() [3/7]

◆ word() [4/7]

◆ word() [5/7]

◆ word() [6/7]

◆ word() [7/7]

Member Function Documentation

◆ valid()

◆ capitalise()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ operator &

◆ operator>>

◆ operator<<

Member Data Documentation

◆ typeName

◆ debug

◆ null