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

Inheritance diagram for VarName:

Collaboration diagram for VarName:

Public Member Functions
	VarName (const VarName &)=default

	VarName (VarName &&)=default

	VarName (const char *s)

	VarName (const std::string &s)

void	stripInvalid ()

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

	word (const word &)=default

	word (word &&w)=default

	word (const string &s, bool doStrip=true)

	word (string &&s, bool doStrip=true)

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

	word (std::string &&s, bool doStrip=true)

	word (const char *s, bool doStrip=true)

	word (const char *s, size_type len, bool doStrip)

	word (Istream &is)

void	stripInvalid ()

word	lessExt () const

word	ext () const

word &	ext (const word &ending)

word &	operator= (const word &s)

word &	operator= (word &&s)

word &	operator= (const string &s)

word &	operator= (string &&s)

word &	operator= (const std::string &s)

word &	operator= (std::string &&s)

word &	operator= (const char *s)

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	hasExt () const

bool	hasExt (const char *ending) const

bool	hasExt (const std::string &ending) const

bool	hasExt (const wordRe &ending) const

bool	removeExt ()

Public Member Functions inherited from string
	string ()=default

	string (const std::string &str)

	string (std::string &&str)

	string (const char *str)

	string (const char *str, const size_type len)

	string (const char c)

	string (const size_type len, const char c)

	string (Istream &is)

bool	match (const std::string &text) const

string &	replace (const std::string &s1, const std::string &s2, size_type pos=0)

string &	replaceAll (const std::string &s1, const std::string &s2, size_type pos=0)

string &	replaceAny (const std::string &s1, const char c2, size_type pos=0)

string &	expand (const bool allowEmpty=false)

bool	removeRepeated (const char character)

bool	removeStart (const std::string &text)

bool	removeStart (const char c)

bool	removeEnd (const std::string &text)

bool	removeEnd (const char c)

void	swap (std::string &str)

bool	operator() (const std::string &text) const

bool	starts_with (const std::string &s) const

bool	starts_with (const char c) const

bool	ends_with (const std::string &s) const

bool	ends_with (const char c) const

size_type	count (const char c) const

bool	startsWith (const std::string &s) const

bool	endsWith (const std::string &s) const

bool	removeTrailing (const char c)

Static Public Member Functions
static bool	valid (char c)

Static Public Member Functions inherited from word
template<class PrimitiveType >
static word	printf (const char *fmt, const PrimitiveType &val)

template<class PrimitiveType >
static word	printf (const std::string &fmt, const PrimitiveType &val)

static bool	valid (char c)

static word	validate (const std::string &s, const bool prefix=false)

static word	validate (const char first, const char last, const bool prefix=false)

Static Public Member Functions inherited from string
template<class StringType >
static bool	valid (const std::string &str)

template<class StringType >
static bool	stripInvalid (std::string &str)

template<class StringType >
static StringType	validate (const std::string &str)

Additional Inherited Members
Static Public Attributes inherited from word
static const char *const	typeName = "word"

static int	debug

static const word	null

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

static int	debug

static const string	null

Protected Member Functions inherited from string
std::string::size_type	find_ext () const

word	ext () const

bool	ext (const word &ending)

bool	hasPath () const

bool	hasExt () const

bool	hasExt (const char *ending) const

bool	hasExt (const std::string &ending) const

bool	hasExt (const wordRe &ending) const

bool	removeExt ()

bool	removePath ()

Static Protected Member Functions inherited from string
static std::string::size_type	find_ext (const std::string &str)

template<class PrimitiveType >
static std::string::size_type	string_printf (std::string &output, const char *fmt, const PrimitiveType &val)

template<class PrimitiveType >
static std::string::size_type	string_printf (std::string &output, const std::string &fmt, const PrimitiveType &val)

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.