Initialise the NamedEnum HashTable from the static list of names. More...

Collaboration diagram for NamedEnum< Enum, nEnum >:

Public Member Functions
	NamedEnum ()
	Construct from names. More...

Enum	read (Istream &) const
	Read a word from Istream and return the corresponding. More...

void	write (const Enum e, Ostream &) const
	Write the name representation of the enumeration to an Ostream. More...

const Enum	operator[] (const char *name) const
	Return the enumeration element corresponding to the given name. More...

const Enum	operator[] (const word &name) const
	Return the enumeration element corresponding to the given name. More...

const char *	operator[] (const Enum e) const
	Return the name of the given enumeration element. More...

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

const char *	names []

Public Member Functions inherited from HashTable< int >
bool	set (const Key &, const T &newElmt)
	Assign a new hashedEntry, overwriting existing entries. More...

	HashTable (const label size=128)
	Construct given initial table size. More...

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const HashTable< T, Key, Hash > &)
	Construct as copy. More...

	HashTable (const Xfer< HashTable< T, Key, Hash > > &)
	Construct by transferring the parameter contents. More...

	~HashTable ()
	Destructor. More...

label	capacity () const
	The size of the underlying table. More...

label	size () const
	Return number of elements in table. More...

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const Key &) const
	Return true if hashedEntry is found in table. More...

iterator	find (const Key &)
	Find and return an iterator set at the hashedEntry. More...

const_iterator	find (const Key &) const
	Find and return an const_iterator set at the hashedEntry. More...

List< Key >	toc () const
	Return the table of contents. More...

List< Key >	sortedToc () const
	Return the table of contents as a sorted list. More...

Ostream &	printInfo (Ostream &) const
	Print information. More...

bool	insert (const Key &, const T &newElmt)
	Insert a new hashedEntry. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const Key &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< Key > &)
	Remove entries given by the listed keys from this HashTable. More...

label	erase (const HashTable< AnyType, Key, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &rhs)

void	resize (const label newSize)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

void	transfer (HashTable< T, Key, Hash > &)
	Transfer the contents of the argument table into this table. More...

Xfer< HashTable< T, Key, Hash > >	xfer ()
	Transfer contents to the Xfer container. More...

T &	operator[] (const Key &)
	Find and return a hashedEntry. More...

const T &	operator[] (const Key &) const
	Find and return a hashedEntry. More...

T &	operator() (const Key &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< T, Key, Hash > &)
	Assignment. More...

bool	operator== (const HashTable< T, Key, Hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< T, Key, Hash > &) const
	The opposite of the equality operation. Takes linear time. More...

iterator	begin ()
	Iterator set to the beginning of the HashTable. More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

Static Public Member Functions
static stringList	strings ()
	The set of names as a list of strings. More...

static wordList	words ()
	The set of names as a list of words. More...

Static Public Attributes
static const char *	names [nEnum]
	The set of names corresponding to the enumeration Enum. More...

Private Member Functions
	StaticAssert (nEnum > 0)
	nEnum must be positive (non-zero) More...

	NamedEnum (const NamedEnum &)
	Disallow default bitwise copy construct. More...

void	operator= (const NamedEnum &)
	Disallow default bitwise assignment. More...

Additional Inherited Members
Public Types inherited from HashTable< int >
typedef T	value_type
	Type of values the HashTable contains. More...

typedef T &	reference
	Type that can be used for storing into HashTable::value_type. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

Data Fields inherited from HashTable< int >
const typedef T &	const_reference
	Type that can be used for storing into constant. More...

Detailed Description

template<class Enum, int nEnum>
class Foam::NamedEnum< Enum, nEnum >

Initialise the NamedEnum HashTable from the static list of names.

Source files

Definition at line 52 of file NamedEnum.H.

Constructor & Destructor Documentation

◆ NamedEnum() [1/2]

NamedEnum ( const NamedEnum< Enum, nEnum > & )

private

Disallow default bitwise copy construct.

◆ NamedEnum() [2/2]

NamedEnum

Construct from names.

Definition at line 31 of file NamedEnum.C.

Member Function Documentation

◆ StaticAssert()

StaticAssert	(	nEnum	,
		0
	)

private

nEnum must be positive (non-zero)

◆ operator=()

void operator= ( const NamedEnum< Enum, nEnum > & )

private

Disallow default bitwise assignment.

◆ read()

Enum read ( Istream & is ) const

Read a word from Istream and return the corresponding.

enumeration element

Definition at line 61 of file NamedEnum.C.

Referenced by nastranSurfaceWriter::nastranSurfaceWriter(), distributedTriSurfaceMesh::read(), solidificationMeltingSource::read(), scene::readCamera(), addfileModificationCheckingToOpt::readData(), addcommsTypeToOpt::readData(), and Time::readDict().

Here is the caller graph for this function:

◆ write()

void write	(	const Enum	e,
		Ostream &	os
	)		const

Write the name representation of the enumeration to an Ostream.

Definition at line 79 of file NamedEnum.C.

◆ strings()

Foam::stringList strings

static

The set of names as a list of strings.

Definition at line 86 of file NamedEnum.C.

◆ words()

Foam::wordList words

static

The set of names as a list of words.

Definition at line 105 of file NamedEnum.C.

Referenced by mappedPatchBase::mappedPatchBase().

Here is the caller graph for this function:

◆ operator[]() [1/3]

const Enum operator[] ( const char * name ) const

inline

Return the enumeration element corresponding to the given name.

Definition at line 101 of file NamedEnum.H.

◆ operator[]() [2/3]

const Enum operator[] ( const word & name ) const

inline

Return the enumeration element corresponding to the given name.

Definition at line 107 of file NamedEnum.H.

◆ operator[]() [3/3]

const char* operator[] ( const Enum e ) const

inline

Return the name of the given enumeration element.

Definition at line 113 of file NamedEnum.H.

◆ names() [1/87]

const char * names

Definition at line 46 of file directions.C.

◆ names() [2/87]

const char * names

Definition at line 41 of file tetDecomposer.C.

◆ names() [3/87]

const char * names

Definition at line 54 of file slidingInterface.C.

◆ names() [4/87]

const char * names

Definition at line 49 of file extendedEdgeMesh.C.

◆ names() [5/87]

const char * names

Definition at line 62 of file extendedEdgeMesh.C.

◆ names() [6/87]

const char * names

Definition at line 77 of file extendedEdgeMesh.C.

◆ names() [7/87]

const char * names

Definition at line 37 of file coordSet.C.

◆ names() [8/87]

const char * names

Definition at line 41 of file vtkUnstructuredReader.C.

◆ names() [9/87]

const char * names

Definition at line 58 of file vtkUnstructuredReader.C.

◆ names() [10/87]

const char * names

Definition at line 70 of file vtkUnstructuredReader.C.

◆ names() [11/87]

const char * names

Definition at line 40 of file fanPressureFvPatchScalarField.C.

◆ names() [12/87]

const char * names

Definition at line 45 of file waveSurfacePressureFvPatchScalarField.C.

◆ names() [13/87]

const char * names

Definition at line 44 of file surfaceDisplacementPointPatchVectorField.C.

◆ names() [14/87]

const char * names

Definition at line 43 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ names() [15/87]

const char * names

Definition at line 47 of file cellSetOption.C.

◆ names() [16/87]

const char * names

Definition at line 69 of file directionalPressureGradientExplicitSource.C.

◆ names() [17/87]

const char * names

Definition at line 43 of file solidificationMeltingSource.C.

◆ names() [18/87]

const char * names

Definition at line 50 of file tabulatedNTUHeatTransfer.C.

◆ names() [19/87]

const char * names

Definition at line 39 of file refineImmersedBoundaryMesh.C.

◆ names() [20/87]

const char * names

Definition at line 37 of file phaseProperties.C.

◆ names() [21/87]

const char * names

Definition at line 72 of file meshRefinement.C.

◆ names() [22/87]

const char * names

Definition at line 87 of file meshRefinement.C.

◆ names() [23/87]

const char * names

Definition at line 97 of file meshRefinement.C.

◆ names() [24/87]

const char * names

Definition at line 41 of file surfaceZonesInfo.C.

◆ names() [25/87]

const char * names

Definition at line 60 of file surfaceZonesInfo.C.

◆ names() [26/87]

const char * names

Definition at line 45 of file shellSurfaces.C.

◆ names() [27/87]

const char * names

Definition at line 33 of file faceAreaIntersect.C.

◆ names() [28/87]

const char * names

Definition at line 57 of file mappedPatchBase.C.

◆ names() [29/87]

const char * names

Definition at line 72 of file mappedPatchBase.C.

◆ names() [30/87]

const char * names

Definition at line 45 of file faceToCell.C.

◆ names() [31/87]

const char * names

Definition at line 44 of file faceZoneToCell.C.

◆ names() [32/87]

const char * names

Definition at line 45 of file pointToCell.C.

◆ names() [33/87]

const char * names

Definition at line 46 of file cellToFace.C.

◆ names() [34/87]

const char * names

Definition at line 45 of file pointToFace.C.

◆ names() [35/87]

const char * names

Definition at line 45 of file cellToPoint.C.

◆ names() [36/87]

const char * names

Definition at line 45 of file faceToPoint.C.

◆ names() [37/87]

const char * names

Definition at line 43 of file topoSetSource.C.

◆ names() [38/87]

const char * names

Definition at line 45 of file booleanSurface.C.

◆ names() [39/87]

const char * names

Definition at line 37 of file volumeType.C.

◆ names() [40/87]

const char * names

Definition at line 43 of file UPstream.C.

◆ names() [41/87]

const char * names

Definition at line 42 of file regIOobject.C.

◆ names() [42/87]

const char * names

Definition at line 43 of file Time.C.

◆ names() [43/87]

const char * names

Definition at line 56 of file Time.C.

◆ names() [44/87]

const char * names

Definition at line 40 of file coupledPolyPatch.C.

◆ names() [45/87]

const char * names

Definition at line 39 of file intersection.C.

◆ names() [46/87]

const char * names

Definition at line 50 of file intersection.C.

◆ names() [47/87]

const char * names

Definition at line 60 of file fileMonitor.C.

◆ names() [48/87]

const char * names

Definition at line 60 of file distributedTriSurfaceMesh.C.

◆ names() [49/87]

const char * names

Definition at line 40 of file fieldAverageItem.C.

◆ names() [50/87]

const char * names

Definition at line 40 of file fieldMinMax.C.

◆ names() [51/87]

const char * names

Definition at line 36 of file cellSource.C.

◆ names() [52/87]

const char * names

Definition at line 44 of file cellSource.C.

◆ names() [53/87]

const char * names

Definition at line 42 of file faceSource.C.

◆ names() [54/87]

const char * names

Definition at line 51 of file faceSource.C.

◆ names() [55/87]

const char * names

Definition at line 43 of file fieldValueDelta.C.

◆ names() [56/87]

const char * names

Definition at line 51 of file fieldVisualisationBase.C.

◆ names() [57/87]

const char * names

Definition at line 58 of file fieldVisualisationBase.C.

◆ names() [58/87]

const char * names

Definition at line 38 of file geometryBase.C.

◆ names() [59/87]

const char * names

Definition at line 44 of file pathline.C.

◆ names() [60/87]

const char * names

Definition at line 44 of file pointData.C.

◆ names() [61/87]

const char * names

Definition at line 46 of file scene.C.

◆ names() [62/87]

const char * names

Definition at line 44 of file surface.C.

◆ names() [63/87]

const char * names

Definition at line 50 of file abortCalculation.C.

◆ names() [64/87]

const char * names

Definition at line 48 of file equationInitialResidualCondition.C.

◆ names() [65/87]

const char * names

Definition at line 52 of file minMaxCondition.C.

◆ names() [66/87]

const char * names

Definition at line 48 of file fluxSummary.C.

◆ names() [67/87]

const char * names

Definition at line 38 of file turbulenceFields.C.

◆ names() [68/87]

const char * names

Definition at line 53 of file turbulenceFields.C.

◆ names() [69/87]

const char * names

Definition at line 40 of file energyRegionCoupledFvPatchScalarField.C.

◆ names() [70/87]

const char * names

Definition at line 42 of file meshToMesh.C.

◆ names() [71/87]

const char * names

Definition at line 49 of file sampledTriSurfaceMesh.C.

◆ names() [72/87]

const char * names

Definition at line 42 of file nastranSurfaceWriter.C.

◆ names() [73/87]

const char * names

Definition at line 54 of file nastranSurfaceWriter.C.

◆ names() [74/87]

const char * names

Definition at line 45 of file humidityTemperatureCoupledMixedFvPatchScalarField.C.

◆ names() [75/87]

const char * names

Definition at line 43 of file boundaryRadiationPropertiesFvPatchField.C.

◆ names() [76/87]

const char * names

Definition at line 41 of file solarCalculator.C.

◆ names() [77/87]

const char * names

Definition at line 52 of file solarCalculator.C.

◆ names() [78/87]

const char * names

Definition at line 42 of file alphaContactAngleFvPatchScalarField.C.

◆ names() [79/87]

const char * names

Definition at line 42 of file externalWallHeatFluxTemperatureFvPatchScalarField.C.

◆ names() [80/87]

const char * names

Definition at line 41 of file temperatureCoupledBase.C.

◆ names() [81/87]

const char * names

Definition at line 43 of file turbulentHeatFluxTemperatureFvPatchScalarField.C.

◆ names() [82/87]

const char * names

Definition at line 44 of file turbulentHeatFluxTemperatureFvPatchScalarField.C.

◆ names() [83/87]

const char * names

Definition at line 49 of file Test-namedEnum.C.

◆ names() [84/87]

const char * names

Definition at line 68 of file extrudeMesh.C.

◆ names() [85/87]

const char * names

Definition at line 72 of file extrudeMesh.C.

◆ names() [86/87]

const char * names

Definition at line 72 of file extrudeMesh.C.

◆ names() [87/87]

const char * names

Definition at line 40 of file bak_turbulentHeatFluxTemperatureFvPatchScalarField.C.

Field Documentation

◆ names

const char* names[nEnum]

static

The set of names corresponding to the enumeration Enum.

Definition at line 73 of file NamedEnum.H.

Referenced by NamedEnum< directionType, 3 >::operator[]().

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

src/OpenFOAM/containers/NamedEnum/NamedEnum.H
src/OpenFOAM/containers/NamedEnum/NamedEnum.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

template<class Enum, int nEnum> class Foam::NamedEnum< Enum, nEnum >

Constructor & Destructor Documentation

◆ NamedEnum() [1/2]

◆ NamedEnum() [2/2]

Member Function Documentation

◆ StaticAssert()

◆ operator=()

◆ read()

◆ write()

◆ strings()

◆ words()

◆ operator[]() [1/3]

◆ operator[]() [2/3]

◆ operator[]() [3/3]

◆ names() [1/87]

◆ names() [2/87]

◆ names() [3/87]

◆ names() [4/87]

◆ names() [5/87]

◆ names() [6/87]

◆ names() [7/87]

◆ names() [8/87]

◆ names() [9/87]

◆ names() [10/87]

◆ names() [11/87]

◆ names() [12/87]

◆ names() [13/87]

◆ names() [14/87]

◆ names() [15/87]

◆ names() [16/87]

◆ names() [17/87]

◆ names() [18/87]

◆ names() [19/87]

◆ names() [20/87]

◆ names() [21/87]

◆ names() [22/87]

◆ names() [23/87]

◆ names() [24/87]

◆ names() [25/87]

◆ names() [26/87]

◆ names() [27/87]

◆ names() [28/87]

◆ names() [29/87]

◆ names() [30/87]

◆ names() [31/87]

◆ names() [32/87]

◆ names() [33/87]

◆ names() [34/87]

◆ names() [35/87]

◆ names() [36/87]

◆ names() [37/87]

◆ names() [38/87]

◆ names() [39/87]

◆ names() [40/87]

◆ names() [41/87]

◆ names() [42/87]

◆ names() [43/87]

◆ names() [44/87]

◆ names() [45/87]

◆ names() [46/87]

◆ names() [47/87]

◆ names() [48/87]

◆ names() [49/87]

◆ names() [50/87]

◆ names() [51/87]

◆ names() [52/87]

◆ names() [53/87]

◆ names() [54/87]

◆ names() [55/87]

◆ names() [56/87]

◆ names() [57/87]

◆ names() [58/87]

◆ names() [59/87]

◆ names() [60/87]

template<class Enum, int nEnum>
class Foam::NamedEnum< Enum, nEnum >