Specification of a valid Ensight variable-name. More...

#include <ensightVarName.H>

Inheritance diagram for VarName:

Collaboration diagram for VarName:

[legend]

Public Member Functions
	VarName (const VarName &)=default
	Copy construct.
	VarName (VarName &&)=default
	Move construct.
	VarName (const char *s)
	Construct as copy of character array.
	VarName (const std::string &s)
	Copy construct from std::string.
	VarName (std::string &&s)
	Move construct from std::string.
void	stripInvalid ()
	Strip invalid characters.
void	operator= (const word &)=delete
void	operator= (const string &)=delete
void	operator= (const std::string &)=delete
void	operator= (const char *)=delete
Public Member Functions inherited from word
	word ()=default
	Default construct.
	word (const word &)=default
	Copy construct.
	word (word &&w)=default
	Move construct.
	word (const string &s, bool doStrip=true)
	Copy construct from Foam::string.
	word (string &&s, bool doStrip=true)
	Move construct from Foam::string.
	word (const std::string &s, bool doStrip=true)
	Copy construct from std::string.
	word (std::string &&s, bool doStrip=true)
	Move construct from std::string.
	word (const char *s, bool doStrip=true)
	Copy from character array.
	word (const char *s, size_type len, bool doStrip)
	Copy from buffer for a maximum number of characters.
	word (Istream &is)
	Construct from Istream.
void	stripInvalid ()
	Strip invalid characters from this word.
word	ext () const
	Return file name extension (part after last .).
word &	ext (const word &ending)
	Append a '.' and the ending, and return the object.
word &	replace_ext (const word &ending)
	Remove extension (if any) and append a new one.
word	lessExt () const
	Return word without extension (part before last .).
word &	operator= (const word &s)
	Copy assignment, no character validation required.
word &	operator= (word &&s)
	Move assignment, no character validation required.
word &	operator= (const string &s)
	Copy assignment from Foam::string, stripping invalid characters.
word &	operator= (string &&s)
	Move assignment from Foam::string, stripping invalid characters.
word &	operator= (const std::string &s)
	Copy assignment from std::string, stripping invalid characters.
word &	operator= (std::string &&s)
	Move assignment from std::string, stripping invalid characters.
word &	operator= (const char *s)
	Copy, stripping invalid characters.
bool	hasExt () const
	Same as has_ext().
bool	hasExt (const std::string &s) const
	Same as has_ext().
bool	removeExt ()
	Same as remove_ext().
template<class PrimitiveType>
Foam::word	printf (const char *fmt, const PrimitiveType &val)
template<class PrimitiveType>
Foam::word	printf (const std::string &fmt, const PrimitiveType &val)
bool	remove_ext ()
	Remove extension, return true if string changed.
bool	has_ext () const
	Various checks for extensions.
bool	has_ext (const char *ending) const
	Various checks for extensions.
bool	has_ext (const std::string &ending) const
	Various checks for extensions.
bool	has_ext (const wordRe &ending) const
	Various checks for extensions.
Public Member Functions inherited from string
	string ()=default
	Default construct.
	string (const std::string &str)
	Copy construct from std::string.
	string (std::string &&str)
	Move construct from std::string.
	string (const char *str)
	Construct as copy of character array.
	string (const char *str, const size_type len)
	Construct as copy with a maximum number of characters.
	string (const char c)
	Construct from a single character.
	string (const size_type len, const char c)
	Construct fill copies of a single character.
	string (Istream &is)
	Construct from Istream.
bool	match (const std::string &text) const
	Test for equality.
string &	replace (const std::string &s1, const std::string &s2, size_type pos=0)
	Replace first occurrence of sub-string s1 with s2, beginning at pos.
string &	replaceAll (const std::string &s1, const std::string &s2, size_type pos=0)
	Replace all occurrences of sub-string s1 with s2, beginning at pos in the string.
string &	replaceAny (const std::string &s1, const char c2, size_type pos=0)
	Replace any occurrence of s1 characters with c2, beginning at pos in the string.
string &	expand (const bool allowEmpty=false)
	Inplace expand initial tags, tildes, and all occurrences of environment variables as per stringOps::expand.
bool	removeRepeated (const char character)
	Remove repeated characters.
bool	removeStart (const std::string &text)
	Remove the given text from the start of the string.
bool	removeStart (const char c)
	Remove leading character, unless string is a single character.
bool	removeEnd (const std::string &text)
	Remove the given text from the end of the string.
bool	removeEnd (const char c)
	Remove trailing character, unless string is a single character.
void	swap (std::string &str)
	Swap contents. Self-swapping is a no-op.
bool	operator() (const std::string &text) const
	Test for equality. Allows use as a predicate.
bool	contains (char c) const noexcept
	True if string contains given character (cf. C++23).
bool	contains (const std::string &s) const noexcept
	True if string contains given [string view] substring (cf. C++23).
bool	contains (const char *s) const
	True if string contains given substring (cf. C++23).
bool	starts_with (char c) const
	True if string starts with given character (cf. C++20).
bool	starts_with (const std::string &s) const
	True if string starts with given [string view] prefix (C++20).
bool	starts_with (const char *s) const
	True if string starts with given prefix (C++20).
bool	ends_with (char c) const
	True if string ends with given character (cf. C++20).
bool	ends_with (const std::string &s) const
	True if string ends with given [string view] suffix (cf. C++20).
bool	ends_with (const char *s) const
	True if string ends with given suffix (cf. C++20).
size_type	count (const char c) const
	Count the number of occurrences of the specified character in the string.
bool	startsWith (const std::string &s) const
	Deprecated(2019-11).
bool	endsWith (const std::string &s) const
	Deprecated(2019-11).
bool	removeTrailing (const char c)
	Deprecated(2019-11).

Static Public Member Functions
static bool	valid (char c)
	Is this character valid for an ensight var-name.
Static Public Member Functions inherited from word
template<class PrimitiveType>
static word	printf (const char *fmt, const PrimitiveType &val)
	Use a printf-style formatter for a primitive.
template<class PrimitiveType>
static word	printf (const std::string &fmt, const PrimitiveType &val)
	Use a printf-style formatter for a primitive.
static bool	valid (char c)
	Is this character valid for a word?
static word	validate (const std::string &s, const bool prefix=false)
	Construct validated word (no invalid characters).
static word	validate (const char first, const char last, const bool prefix=false)
	Construct validated word (no invalid characters) from a sequence of characters in the range [first,last),.
Static Public Member Functions inherited from string
static std::string::size_type	length (const char *s)
	Length of the character sequence (with nullptr protection).
static std::string::size_type	length (const std::string &s)
	The length of the string.
template<class StringType>
static bool	valid (const std::string &str)
	Does the string contain valid characters only?
template<class StringType>
static bool	stripInvalid (std::string &str)
	Strip invalid characters from the given string.
template<class StringType>
static StringType	validate (const std::string &str)
	Return a valid String from the given string.

Additional Inherited Members
Static Public Attributes inherited from word
static const char *const	typeName = "word"
	The typeName.
static int	debug
	Debugging.
static const word	null
	An empty word.
Static Public Attributes inherited from string
static const char *const	typeName = "string"
	The type name "string".
static int	debug
	The debug flag.
static const string	null
	An empty string.
Protected Member Functions inherited from string
std::string::size_type	find_ext () const
	Find position of a file extension dot, return npos on failure.
word	ext () const
	Return file name extension (part after last .).
bool	ext (const word &ending)
	Append a '.' and the ending.
bool	has_ext () const
	Return true if it has an extension or simply ends with a '.'.
bool	has_ext (const char *ending) const
	Return true if the extension is the same as the given ending.
bool	has_ext (const std::string &ending) const
	Return true if the extension is the same as the given ending.
bool	has_ext (const wordRe &ending) const
	Return true if the extension matches the given ending.
bool	remove_path ()
	Remove leading path, return true if string changed.
bool	remove_ext ()
	Remove extension, return true if string changed.
Static Protected Member Functions inherited from string
static std::string::size_type	find_ext (const std::string &str)
	Find position of a file extension dot, return npos on failure.
template<class PrimitiveType>
static std::string::size_type	string_printf (std::string &output, const char *fmt, const PrimitiveType &val)
	A printf-style formatter for a primitive.
template<class PrimitiveType>
static std::string::size_type	string_printf (std::string &output, const std::string &fmt, const PrimitiveType &val)
	A printf-style formatter for a primitive.

Detailed Description

Specification of a valid Ensight variable-name.

Illegal characters

space !#%()*+,-./;@[]^

If spaces exist, they must be quoted

Variable names cannot start with a digit. The maximum part name length (in GUI: 49 chars) - not addressed. The maximum variable length (in GUI: 49 chars) - not addressed.

Definition at line 53 of file ensightVarName.H.