A polymorphic typed union of simple primitive and VectorSpace types. It uses a 'fatter' representation that includes standard VectorSpace types, which avoids heap allocations at the expense of more storage. This is mostly not an issue since lists and fields would box/unbox an entire field, not individual values. More...

#include <exprValue.H>

Public Member Functions
	exprValue ()
	Default construct (zero-initialized) as 'none'.
	exprValue (const exprValue &rhs)
	Copy construct (deep copy).
template<class Type>
	exprValue (const Type &val)
	Construct from Type. Fatal for unsupported types.
expressions::valueTypeCode	typeCode () const noexcept
	The value type code.
bool	good () const noexcept
	True if the value type is not none/invalid.
bool	is_integral () const noexcept
	True if the value type is an integral (bool or label).
direction	nComponents () const noexcept
	The number of components associated with the value type.
direction	rank () const noexcept
	The vector-space rank associated with the value type.
word	valueTypeName () const
	The name for the value type. Similar to pTraits typeName.
word	listCompoundName () const
	The name for the compound token (for a List of values). Eg, `List<scalar>`, `List<vector>` ...
void	clear ()
	Reset to 'none'.
bool	read (Istream &is)
	Read read tokens (if possible).
bool	readTokens (ITstream &is)
	Guess type and read tokens (if possible).
int	compare (const exprValue &rhs) const
	Compare (type,value).
template<class Type>
const Type *	isA () const noexcept
	Return non-null pointer to the data element (if types match). Can also be tested as a bool.
template<class Type>
bool	set (const Type &val)
	Assign from type. Returns false and sets to 'none' for unsupported types.
template<class Type>
const Type &	get () const
	Return the value. Return pTraits zero if the types mismatch.
bool	is_scalar () const noexcept
void	operator= (const scalar &val)
bool	is_vector () const noexcept
void	operator= (const vector &val)
bool	is_tensor () const noexcept
void	operator= (const tensor &val)
bool	is_symmTensor () const noexcept
void	operator= (const symmTensor &val)
bool	is_sphericalTensor () const noexcept
void	operator= (const sphericalTensor &val)
bool	is_label () const noexcept
void	operator= (const label &val)
bool	is_bool () const noexcept
void	operator= (const bool &val)
void	operator= (const exprValue &rhs)
	Copy assignment.
void	operator= (Foam::zero)
	Assign from zero. Changes value but not type.
const char *	cdata_bytes () const noexcept
	Pointer to the data content as byte data.
char *	data_bytes () noexcept
	Pointer to the data content as byte data.
bool	operator== (const exprValue &rhs) const
	Compare (type,value) for equality.
bool	operator!= (const exprValue &rhs) const
	Compare (type,value) for inequality.
bool	operator< (const exprValue &rhs) const
	Compare (type,value).
InfoProxy< exprValue >	info () const
	Return info proxy for printing information to a stream.
void	write (Ostream &os, bool prune=false) const
	Write the (type-specific) content.

Static Public Member Functions
static bool	good (const expressions::valueTypeCode) noexcept
	True if valueTypeCode is not none/invalid.
static bool	is_integral (const expressions::valueTypeCode) noexcept
	True if valueTypeCode is bool/label.
static direction	nComponents (const expressions::valueTypeCode) noexcept
	The number of components associated with the valueTypeCode.
static direction	rank (const expressions::valueTypeCode) noexcept
	The vector-space rank associated with the valueTypeCode.
template<class Type>
static bool	supportedType ()
	True if the specified type is supported.
static expressions::valueTypeCode	peekType (const ITstream &is)
	Detect the type from the available tokens.
static bool	read (const std::string &str, exprValue &val)
	Read entire string as a exprValue, skipping leading/trailing whitespace.
static constexpr unsigned	size_bytes () noexcept
	Size of the (contiguous) data content as byte data is compile-time constant.

Detailed Description

A polymorphic typed union of simple primitive and VectorSpace types. It uses a 'fatter' representation that includes standard VectorSpace types, which avoids heap allocations at the expense of more storage. This is mostly not an issue since lists and fields would box/unbox an entire field, not individual values.

Forward declarations for Foam::expressions::exprValue etc.

Source files

Definition at line 157 of file exprValue.H.

Constructor & Destructor Documentation

◆ exprValue() [1/3]

exprValue ( )

inline

Default construct (zero-initialized) as 'none'.

Definition at line 92 of file exprValueI.H.

References clear().

Referenced by compare(), exprValue(), operator!=(), operator<(), operator=(), operator==(), read(), and size_bytes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exprValue() [2/3]

exprValue ( const exprValue & rhs )

inline

Copy construct (deep copy).

Definition at line 98 of file exprValueI.H.

References exprValue(), and Foam::rhs().

Here is the call graph for this function:

◆ exprValue() [3/3]

template<class Type>

exprValue ( const Type & val )

inlineexplicit

Construct from Type. Fatal for unsupported types.

Definition at line 105 of file exprValueI.H.

References Foam::abort(), clear(), Foam::FatalError, FatalErrorInFunction, good(), name, Foam::nl, and set().

Here is the call graph for this function:

Member Function Documentation

◆ good() [1/2]

bool good ( const expressions::valueTypeCode valTypeCode )

inlinestaticnoexcept

True if valueTypeCode is not none/invalid.

Definition at line 25 of file exprValueI.H.

References Foam::expressions::INVALID, and Foam::expressions::NONE.

Referenced by compare(), exprValue(), and listCompoundName().

Here is the caller graph for this function:

◆ is_integral() [1/2]

bool is_integral ( const expressions::valueTypeCode valTypeCode )

inlinestaticnoexcept

True if valueTypeCode is bool/label.

Definition at line 38 of file exprValueI.H.

References Foam::expressions::type_bool, and Foam::expressions::type_label.

◆ nComponents() [1/2]

Foam::direction nComponents ( const expressions::valueTypeCode valTypeCode )

inlinestaticnoexcept

The number of components associated with the valueTypeCode.

Definition at line 51 of file exprValueI.H.

References Foam::expressions::Detail::nComponents().

Here is the call graph for this function:

◆ rank() [1/2]

Foam::direction rank ( const expressions::valueTypeCode valTypeCode )

inlinestaticnoexcept

The vector-space rank associated with the valueTypeCode.

Definition at line 60 of file exprValueI.H.

References Foam::expressions::Detail::rank().

Here is the call graph for this function:

◆ supportedType()

template<class Type>

bool supportedType ( )

inlinestatic

True if the specified type is supported.

Definition at line 70 of file exprValueI.H.

References Foam::expressions::INVALID, and exprTypeTraits< Type >::value.

◆ peekType()

Foam::expressions::valueTypeCode peekType ( const ITstream & is )

static

Detect the type from the available tokens.

Possible ambiguity between label and scalar.

Returns: INVALID for unsupported type

InfoErr << "check token: " << (endCmpti-firstCmpti) << " : " << is[endCmpti].name() << nl;

InfoErr<< "check token: " << tok0.info() << nl;

Definition at line 135 of file exprValue.C.

References token::BEGIN_LIST, token::END_LIST, good(), token::good(), ITstream::hasPutback(), Foam::expressions::INVALID, token::isLabel(), token::isNumber(), token::isPunctuation(), token::isScalar(), Foam::expressions::NONE, ITstream::peek(), UList< T >::size(), ITstream::tokenIndex(), and exprTypeTraits< Type >::value.

Referenced by readTokens().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [1/2]

bool read	(	const std::string &	str,
		exprValue &	val )

static

Read entire string as a exprValue, skipping leading/trailing whitespace.

Returns: True if successful.

Definition at line 232 of file exprValue.C.

References exprValue(), ITstream::nRemainingTokens(), and readTokens().

Here is the call graph for this function:

◆ typeCode()

expressions::valueTypeCode typeCode ( ) const

inlinenoexcept

The value type code.

Definition at line 270 of file exprValue.H.

References Foam::noexcept.

◆ good() [2/2]

bool good ( ) const

inlinenoexcept

True if the value type is not none/invalid.

Definition at line 123 of file exprValueI.H.

References good(), and Foam::noexcept.

Referenced by good(), and peekType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_integral() [2/2]

bool is_integral ( ) const

inlinenoexcept

True if the value type is an integral (bool or label).

Definition at line 129 of file exprValueI.H.

References is_integral(), and Foam::noexcept.

Referenced by is_integral().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nComponents() [2/2]

Foam::direction nComponents ( ) const

inlinenoexcept

The number of components associated with the value type.

Definition at line 136 of file exprValueI.H.

References Foam::expressions::Detail::nComponents(), and Foam::noexcept.

Here is the call graph for this function:

◆ rank() [2/2]

Foam::direction rank ( ) const

inlinenoexcept

The vector-space rank associated with the value type.

Definition at line 143 of file exprValueI.H.

References Foam::noexcept, and Foam::expressions::Detail::rank().

Here is the call graph for this function:

◆ valueTypeName()

Foam::word valueTypeName ( ) const

inline

The name for the value type. Similar to pTraits typeName.

Definition at line 150 of file exprValueI.H.

References Foam::name().

Here is the call graph for this function:

◆ listCompoundName()

Foam::word listCompoundName ( ) const

inline

The name for the compound token (for a List of values). Eg, List<scalar>, List<vector> ...

Definition at line 156 of file exprValueI.H.

References good(), and Foam::name().

Here is the call graph for this function:

◆ clear()

void clear ( )

Reset to 'none'.

Definition at line 247 of file exprValue.C.

◆ read() [2/2]

bool read ( Istream & is )

Read read tokens (if possible).

Returns: True on success

Definition at line 374 of file exprValue.C.

References ITstream::add_tokens(), token::BEGIN_LIST, token::END_LIST, IOstream::fatalCheck(), FUNCTION_NAME, token::good(), token::isPunctuation(), readTokens(), List< T >::resize(), ITstream::seek(), and ITstream::tokenIndex().

Here is the call graph for this function:

◆ readTokens()

bool readTokens ( ITstream & is )

Guess type and read tokens (if possible).

Returns: True on success

Definition at line 423 of file exprValue.C.

References IOstream::bad(), clear(), doLocalCode, FOR_ALL_EXPR_VALUE_TYPES, Foam::expressions::INVALID, token::isWord(), Foam::expressions::NONE, ITstream::peek(), peekType(), and ITstream::skip().

Referenced by read(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compare()

int compare ( const exprValue & rhs ) const

Compare (type,value).

Definition at line 471 of file exprValue.C.

References doLocalCode, exprValue(), FOR_ALL_EXPR_VALUE_TYPES, good(), and Foam::rhs().

Referenced by operator<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isA()

template<class Type>

const Type * isA ( ) const

inlinenoexcept

Return non-null pointer to the data element (if types match). Can also be tested as a bool.

Definition at line 209 of file exprValueI.H.

References Foam::noexcept, and exprTypeTraits< Type >::value.

◆ set()

template<class Type>

bool set ( const Type & val )

inline

Assign from type. Returns false and sets to 'none' for unsupported types.

Definition at line 169 of file exprValueI.H.

References clear(), Foam::expressions::INVALID, Foam::expressions::NONE, and exprTypeTraits< Type >::value.

Referenced by exprValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

template<class Type>

const Type & get ( ) const

inline

Return the value. Return pTraits zero if the types mismatch.

void operator= ( const label & val )

inline

Assign from label

Definition at line 368 of file exprValue.H.

◆ is_bool()

bool is_bool ( ) const

inlinenoexcept

True if value is a bool

Definition at line 368 of file exprValue.H.

References defineUnionMethods.

◆ operator=() [7/9]

void operator= ( const bool & val )

inline

Assign from bool

Definition at line 368 of file exprValue.H.

◆ operator=() [8/9]

void operator= ( const exprValue & rhs )

inline

Copy assignment.

Definition at line 375 of file exprValue.H.

References exprValue(), and Foam::rhs().

Here is the call graph for this function:

◆ operator=() [9/9]

void operator= ( Foam::zero )

inline

Assign from zero. Changes value but not type.

Definition at line 380 of file exprValue.H.

◆ cdata_bytes()

const char * cdata_bytes ( ) const

inlinenoexcept

Pointer to the data content as byte data.

Definition at line 388 of file exprValue.H.

References Foam::noexcept.

◆ data_bytes()

char * data_bytes ( )

inlinenoexcept

Pointer to the data content as byte data.

Definition at line 396 of file exprValue.H.

References Foam::noexcept.

◆ size_bytes()

constexpr unsigned size_bytes ( )

inlinestaticconstexprnoexcept

Size of the (contiguous) data content as byte data is compile-time constant.

Definition at line 405 of file exprValue.H.

References exprValue(), and Foam::noexcept.

Here is the call graph for this function:

◆ operator==()

bool operator== ( const exprValue & rhs ) const

Compare (type,value) for equality.

Definition at line 525 of file exprValue.C.

References doLocalCode, exprValue(), FOR_ALL_EXPR_VALUE_TYPES, and Foam::rhs().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const exprValue & rhs ) const

inline

Compare (type,value) for inequality.

Definition at line 421 of file exprValue.H.

References exprValue(), and Foam::rhs().

Here is the call graph for this function:

◆ operator<()

bool operator< ( const exprValue & rhs ) const

Compare (type,value).

Definition at line 561 of file exprValue.C.

References compare(), exprValue(), and Foam::rhs().

Here is the call graph for this function:

◆ info()

InfoProxy< exprValue > info ( ) const

inline

Return info proxy for printing information to a stream.

Definition at line 434 of file exprValue.H.

◆ write()

void write	(	Ostream &	os,
		bool	prune = false ) const

Write the (type-specific) content.

For none : emits pair of brackets. For invalid : emits "bad".

Use OTstream for the stream to recover as tokens.

Parameters

prune suppress the output for none/invalid

Definition at line 323 of file exprValue.C.

References token::BEGIN_LIST, doLocalCode, token::END_LIST, FOR_ALL_EXPR_VALUE_TYPES, Foam::expressions::INVALID, Foam::expressions::NONE, and os().

Here is the call graph for this function:

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

src/OpenFOAM/expressions/value/exprValue.H
src/OpenFOAM/expressions/value/exprValue.C
src/OpenFOAM/expressions/value/exprValueI.H

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ exprValue() [1/3]

◆ exprValue() [2/3]

◆ exprValue() [3/3]

Member Function Documentation

◆ good() [1/2]

◆ is_integral() [1/2]

◆ nComponents() [1/2]

◆ rank() [1/2]

◆ supportedType()

◆ peekType()

◆ read() [1/2]

◆ typeCode()

◆ good() [2/2]

◆ is_integral() [2/2]

◆ nComponents() [2/2]

◆ rank() [2/2]

◆ valueTypeName()

◆ listCompoundName()

◆ clear()

◆ read() [2/2]

◆ readTokens()

◆ compare()

◆ isA()

◆ set()

◆ get()

◆ is_scalar()

◆ operator=() [1/9]

◆ is_vector()

◆ operator=() [2/9]

◆ is_tensor()

◆ operator=() [3/9]

◆ is_symmTensor()

◆ operator=() [4/9]

◆ is_sphericalTensor()

◆ operator=() [5/9]

◆ is_label()

◆ operator=() [6/9]

◆ is_bool()

◆ operator=() [7/9]

◆ operator=() [8/9]

◆ operator=() [9/9]

◆ cdata_bytes()

◆ data_bytes()

◆ size_bytes()

◆ operator==()

◆ operator!=()

◆ operator<()

◆ info()

◆ write()