ADTF: string_base< storageT >

Member Function Documentation

◆ Append() [1/2]

_myType& Append	(	const _myType &	strString,
		tSize	nLength = `InvalidPos`
	)

inline

This function appends a string to the end of the cStringA object.

Note: Please note that the string may only contain non-binary data!

Parameters

strString	[in] cStringA object to be appended.
nLength	[in] Number of characters that will be taken from strString for appending

Returns: The function returns a reference to itself containing the new string contents.

Definition at line 503 of file string.h.

References string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, and string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::Filter(), string_base< storageT >::Insert(), A_UTILS_NS::operator+(), string_base< storageT >::operator+=(), and string_base< storageT >::Replace().

◆ Append() [2/2]

_myType& Append ( tChar c )

inline

This function appends one character to the end of the cStringA object.

Note: Please note that appending a 0-Byte character ('\0') will be ignored.

Parameters

c	[in] Character to be appended.

Returns: The function returns a reference to itself containing the new string contents.

Definition at line 543 of file string.h.

References string_base< storageT >::GetLength(), and string_base< storageT >::m_oStorageBuffer.

◆ AsBool()

tBool AsBool ( ) const

inline

This function converts the string to a boolean value.

Only the following strings will be interpreted as true (not case sensitive): "true","on","1", all other strings will be interpreted as false. If a string is concatenate by a true-literal (and vice versa) it is interpreted as false.

Returns: Converted boolean value

Definition at line 2311 of file string.h.

◆ AsFloat32()

tFloat32 AsFloat32 ( ) const

inline

This function converts the string to a floating-point value.

The string has to be in the following format to be interpreted as a float: [whitespace][sign][digits][(.|,)digits][{d|D|e|E}[sign]digits]. If the number is written as a hex-number the string can be converted, too. i.e "0x4fff abc". Both '.' and ',' are interpreted as decimal point.

Returns: Converted floating-point value, 0.0 if value can not be converted

Definition at line 2265 of file string.h.

◆ AsFloat64()

tFloat64 AsFloat64 ( ) const

inline

This function converts the string to a floating-point value.

Returns: Converted floating-point value, 0.0 if value can not be converted

Definition at line 2218 of file string.h.

◆ AsInt32()

tInt32 AsInt32 ( ) const

inline

This function converts the string to an integer value.

The function stops reading at the first character, that is not part of a number. i.e. "123abc" can be converted, but "abc123" not. If the number is written as a hex-number the string can be converted, too. i.e "0x4fff abc". More Information about converting hex-numbers see

See also: HexToInt().

Returns: Converted integer value

Definition at line 2026 of file string.h.

◆ AsInt64()

tInt64 AsInt64 ( ) const

inline

This function converts the string to an integer value.

See also: HexToInt(). If there is a negative integer, the 0 will be returned. A number with the prefix "+" will be correctly interpreted.

Returns: Converted integer value

Definition at line 2121 of file string.h.

Referenced by adtf::remote::ant::parse_logging_rpc_buffer().

◆ AsUInt32()

tUInt32 AsUInt32 ( ) const

inline

This function converts the string to an integer value.

See also: HexToInt(). If there is a negative integer, the 0 will be returned. A number with the prefix "+" will be correctly interpreted

Returns: Converted integer value or 0 (error case) i.e. negative numbers

Definition at line 2072 of file string.h.

Referenced by adtf::remote::ant::parse_logging_rpc_buffer().

◆ AsUInt64()

tUInt64 AsUInt64 ( ) const

inline

This function converts the string to an integer value.

See also: HexToInt().

Returns: Converted integer value or 0 (error case) i.e. negative numbers

Definition at line 2170 of file string.h.

Referenced by string_base< storageT >::IsEqual(), string_base< storageT >::IsNotEqual(), string_base< storageT >::operator!=(), xml_string_compare_func::operator()(), string_base_compare_func< sT, sT2 >::operator()(), string_base< storageT >::operator<(), A_UTILS_NS::operator<(), string_base< storageT >::operator<=(), A_UTILS_NS::operator<=(), string_base< storageT >::operator==(), string_base< storageT >::operator>(), A_UTILS_NS::operator>(), string_base< storageT >::operator>=(), A_UTILS_NS::operator>=(), and string_base< storageT >::StartsWith().

◆ Compare() [1/2]

tInt Compare	(	const _myType &	strString,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function compares a cStringA object with another string using the generic-text function _tcscmp.

The generic-text function _tcscmp, which is defined in tChar.H, maps to either strcmp, wcscmp, or _mbscmp depending on the character set that is defined at compile time. Each of these functions performs a case-sensitive comparison of the strings, and is not affected by locale.

Parameters

[in]	strString	The other string used for comparison.
[in]	nPos	beginning position to compare
[in]	nLength	amount of characters to be compared. -1 means until end

Returns: Zero if the strings are identical, < 0 if the cStringA object is less than the string parameter strString, or > 0 if the cStringA object is greater than the string given in parameter strString.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 695 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ Compare() [2/2]

tInt Compare	(	const tChar *	strString,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function compares a cStringA object with another string using the generic-text function _tcscmp.

Parameters

[in]	strString	The other string used for comparison.
[in]	nPos	beginning position to compare
[in]	nLength	amount of characters to be compared. -1 means until end

Returns: Zero if the strings are identical, < 0 if the cStringA object is less than the string parameter strString, or > 0 if the cStringA object is greater than the string given in parameter strString.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 716 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ CompareNoCase()

tInt CompareNoCase	(	const _myType &	strString,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function compares a cStringA object with another string using the generic-text function _tcsicmp.

The generic-text function _tcsicmp, which is defined in tChar.H, maps to either _stricmp, _wcsicmp, _mbsicmp depending on the character set that is defined at compile time. Each of these functions performs a case-insensitive comparison of the strings, and is not affected by locale..

Parameters

strString	[in] The other string used for comparison.
nPos	[in] Compare from position nPos.
nLength	[in] Compare only nLength characters.

Returns: Zero if the strings are identical (ignoring case), <0 if the cStringA object is less than parameter strString (ignoring case), or >0 if the cStringA object is greater the string given in parameter strString (ignoring case).

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 744 of file string.h.

References cStringUtil::CompareNoCase(), and string_base< storageT >::GetPtr().

Referenced by string_base< storageT >::IsNotEqualNoCase(), string_base_no_case_compare_func< sT, sT2 >::operator()(), and string_base< storageT >::StartsWith().

◆ Copy()

static _myType& Copy	(	_myType &	strDestination,
		const _myType &	strSource,
		tSize	szLength = `InvalidPos`
	)

inlinestatic

Copies the value of one StringObject to another Stringobject.

Parameters

[out]	strDestination	Reference to the string that should store the copied value.
[in]	strSource	Reference to the source string from which the copy will be made.
[in]	szLength	Number of characters to be taken from the source string. As default, the complete string is copied.

Returns: Reference to the copied string.

Definition at line 2460 of file string.h.

References string_base< storageT >::Append(), string_base< storageT >::Find(), string_base< storageT >::GetAt(), string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, string_base< storageT >::IsEmpty(), string_base< storageT >::m_oStorageBuffer, and string_base< storageT >::SetBuffer().

◆ CountString()

tSize CountString	(	const _myType &	strFind,
		tSize	nStart = `0`
	)		const

inline

This counts the occurrences of a given substring in a string.

Parameters

strFind	[in] Substring to be searched for.
nStart	[in] Start position that the search begins with.

Returns: Number of occurrences of the given substring.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 968 of file string.h.

References string_base< storageT >::Find(), string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, and string_base< storageT >::IsEmpty().

◆ Delete()

_myType& Delete	(	tSize	nPos,
		tSize	nLength = `InvalidPos`
	)

inline

This function deletes a substring of length nLength characters from the cStringA object, starting at position nPos (zero-based).

The function returns a copy of the resulting string.

Parameters

nPos	[in] The zero-based index of the first character in the cStringA object that is to be deleted.
nLength	[in] The number of characters to delete from this cStringA object. If this parameter is not supplied, then the remainder of the string is deleted.

Returns: A copy of the resulting string.

Definition at line 584 of file string.h.

References string_base< storageT >::Clear(), string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, string_base< storageT >::IsEmpty(), and string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::DropQuotes(), string_base< storageT >::LeftTrim(), string_base< storageT >::NumTrim(), and string_base< storageT >::RightTrim().

◆ DropQuotes()

tVoid DropQuotes ( )

inline

This function removes quotes from a cStringA object.

Quotes are '"' and '\''

Returns: tVoid

Definition at line 1725 of file string.h.

References string_base< storageT >::begin(), string_base< storageT >::Delete(), string_base< storageT >::GetLength(), string_base< storageT >::IsEmpty(), and string_base< storageT >::rbegin().

◆ EndsWith()

tBool EndsWith	(	const _myType &	strEndsWith,
		const tBool	bNoCase = `tFalse`
	)		const

inline

This function checks if the string ends with a given postfix.

Parameters

strEndsWith	[in] The postfix to check for.
bNoCase	[in] Whether or not to check case insensitive or not.

Returns: tTrue if it ends with the postfix, otherwise tFalse.

Definition at line 1182 of file string.h.

References string_base< storageT >::GetLength(), string_base< storageT >::IsEqual(), string_base< storageT >::IsEqualNoCase(), string_base< storageT >::Right(), and tFalse.

Referenced by string_base< storageT >::Split().

◆ Escape()

_myType& Escape ( )

inline

Escape control characters.

Returns: New cString object containing the formatted data.

Definition at line 1793 of file string.h.

References string_base< storageT >::begin(), string_base< storageT >::GetBufferSize(), string_base< storageT >::GetLength(), string_base< storageT >::GetPtr(), string_base< storageT >::IsEmpty(), string_base< storageT >::Set(), string_base< storageT >::SetBuffer(), tFalse, and tTrue.

◆ Filter() [1/2]

tSize Filter ( const _myType & strCharList )

inline

This function removes all occurrences of each character given in a token list.

Parameters

strCharList [in] List of characters to be removed from the string.

Returns: Number of characters that have been removed from the string.

Definition at line 1103 of file string.h.

◆ Filter() [2/2]

tSize Filter ( tChar cChar )

inline

This function removes all occurrences of a given character from a string.

Parameters

cChar [in] Character to be removed from the string.

Returns: Number of characters that have been removed from the string.

Definition at line 1087 of file string.h.

◆ Find() [1/2]

tSize Find	(	const _myType &	strStringToFind,
		tSize	nStart = `0`,
		const tBool	bNoCase = `tFalse`
	)		const

inline

This function searches the cStringA object for the first match of a substring.

Parameters

strStringToFind	[in] A substring to search for.
nStart	[in] The index of the character in the string to begin the search with, or 0 to start from the beginning.
bNoCase	[in] Compare case sensitive if flag is tFalse

Returns: The zero-based index of the first character in this cStringA object that matches the requested substring; -1 if the substring is not found.

Definition at line 837 of file string.h.

References string_base< storageT >::Find(), string_base< storageT >::m_oStorageBuffer, and string_base< storageT >::ToLower().

Referenced by string_base< storageT >::CountString(), string_base< storageT >::Filter(), string_base< storageT >::Find(), string_base< storageT >::Replace(), and string_base< storageT >::Split().

◆ Find() [2/2]

tSize Find	(	tChar	cToFind,
		tSize	nStart = `0`
	)		const

inline

This function searches the cStringA object for the first match of the specified character.

Parameters

cToFind	[in] A single character to search for.
nStart	[in] The index of the character in the string to begin the search with, or 0 to start from the beginning.

Returns: The zero-based index of the first character in this cStringA object that matches the requested characters; -1 if the character is not found.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 869 of file string.h.

References string_base< storageT >::Find(), and tFalse.

◆ FindNotToken()

tSize FindNotToken	(	const _myType &	strTokenList,
		tSize	nStart = `0`
	)		const

inline

This function searches a string for the first character that matches none of the characters contained in a token list.

Parameters

strTokenList	[in] String containing characters for matching.
nStart	[in] The index of the character in the string to begin the search with, or 0 to start from the beginning.

Returns: The zero-based index of the first character in this string that is not also in the token list; -1 if there is no match.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 943 of file string.h.

References string_base< storageT >::InvalidPos, string_base< storageT >::IsEmpty(), and string_base< storageT >::m_oStorageBuffer.

◆ FindToken()

tSize FindToken	(	const _myType &	strTokenList,
		tSize	nStart = `0`
	)		const

inline

This function searches a string for the first character that matches any character contained in a token list.

Parameters

strTokenList	[in] String containing characters for matching.
nStart	[in] The index of the character in the string to begin the search with, or 0 to start from the beginning.

Returns: The zero-based index of the first character in this string that is also in the token list; -1 if there is no match.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 914 of file string.h.

References string_base< storageT >::InvalidPos, string_base< storageT >::IsEmpty(), and string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::NumTrim(), and string_base< storageT >::SplitToken().

◆ Format()

static _myType Format	(	const value_type *	strFormat,
			...
	)

inlinestatic

Write formatted data to a string.

The Format method formats and stores a series of characters and values in a new cString buffer object. Each argument (if any) is converted and output according to the corresponding format specification in format. The format consists of ordinary characters and has the same form and function as the format argument for printf. If copying occurs between strings that overlap, the behavior is undefined.
For 64-Bit-Integer conversion use lld (Win32, Linux) or I64d (only Win32). lld maps to a long long integer whereas I64d maps to an integer with 64-bit size. The first one may not be typesafe but is portable between Windows and Linux.

Parameters

[in]	strFormat	Format control string.
[in]	args	Variable argument list.

Returns: New cString object containing the formatted data.

Definition at line 2405 of file string.h.

◆ FromType() [1/7]

static _myType FromType	(	tBool	bValue,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a boolean value.

The numeric data is converted to an unformatted string.

Parameters

[in]	bValue	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2342 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ FromType() [2/7]

static _myType FromType	(	tFloat32	f32Value,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a numeric value.

The numeric data is converted to an unformatted string.

Parameters

[in]	f32Value	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2296 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ FromType() [3/7]

static _myType FromType	(	tFloat64	f64Value,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a numeric value.

The numeric data is converted to an unformatted string.

Parameters

[in]	f64Value	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2249 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ FromType() [4/7]

static _myType FromType	(	tInt32	i32Value,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a numeric value.

Parameters

[in]	i32Value	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2056 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ FromType() [5/7]

static _myType FromType	(	tInt64	i64Value,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a numeric value.

The numeric data is converted to an unformatted string.

Parameters

[in]	i64Value	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2154 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ FromType() [6/7]

static _myType FromType	(	tUInt32	ui32Value,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a numeric value.

Parameters

[in]	ui32Value	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2103 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ FromType() [7/7]

static _myType FromType	(	tUInt64	ui64Value,
		const _myType &	strFormat = `Empty`
	)

inlinestatic

This function creates a new cString object from a numeric value.

The numeric data is converted to an unformatted string.

Parameters

[in]	ui64Value	Numeric value.
[in]	strFormat	Format definition (see Format).

Returns: New cString object containing the string representation of the number.

Definition at line 2202 of file string.h.

References string_base< storageT >::ToStringFromType().

◆ GetAt()

tChar GetAt ( tSize nIdx ) const

inline

You can think of a cStringA object as an array of characters.

The GetAt member function returns a single character specified by an index number.

Parameters

nIdx	[in] Zero-based index of the character in the cStringA object. The nIndex parameter must be greater than or equal to 0 and less than the value returned by GetLength.

Returns: A tChar containing the character at the specified position in the string.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 383 of file string.h.

References string_base< storageT >::GetLength(), and string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::Filter(), and string_base< storageT >::NumTrim().

◆ GetBuffer()

tChar* GetBuffer ( )

inline

This function returns the pointer to the data.

Returns: tChar* to the beginning of the array

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 486 of file string.h.

References string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::ToStringFromType().

◆ GetBufferSize()

tSize GetBufferSize ( ) const

inline

Get the size of the internal allocated string buffer.

The returned size also includes the null-terminating byte ('\0').

Returns: the internal size of the string buffer (including the null-terminating byte ('\0')).

Definition at line 362 of file string.h.

References string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::Escape(), string_base< storageT >::SetBuffer(), and string_base< storageT >::ToStringFromType().

◆ GetLength()

tSize GetLength ( ) const

inline

This function returns the number of characters in a cStringA object.

Returns: tSize value that contains the number of characters of a '\0' terminated cStringA object.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 315 of file string.h.

References cStringUtil::GetLength(), and string_base< storageT >::GetPtr().

◆ GetMaxBufferSize()

tSize GetMaxBufferSize ( ) const

inline

Return maximum size of string buffer.

Returns: tSize buffer size

Definition at line 2366 of file string.h.

References string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::ToStringFromType().

◆ GetPtr()

const tChar* GetPtr ( ) const

inline

This function returns the current string as an array of characters (c-style)

Returns: tChar* to the beginning of the array

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 473 of file string.h.

References string_base< storageT >::m_oStorageBuffer.

◆ HexToInt64()

tInt64 HexToInt64 ( ) const

inline

This function converts a hexadecimal string representation to an integer value.

A valid hex number has the following representation [+-]? 0? x? {[0-9a-fA-F]*

Returns: Converted integer value

Definition at line 2354 of file string.h.

References string_base< storageT >::HexToType().

◆ HexToType()

tVoid HexToType ( tInt64 & i64Value ) const

inline

This function converts a hexadecimal string representation to an integer value.

A valid hex number has the following representation [+-]? 0? x? {[0-9a-fA-F]*

Parameters

[out] i64Value Reference to the integer variable that should store the converted value.

Returns: tVoid

Definition at line 2381 of file string.h.

References string_base< storageT >::GetPtr(), and cStringUtil::HexToType().

Referenced by string_base< storageT >::HexToInt64().

◆ Insert() [1/2]

_myType& Insert	(	const _myType &	strToInsertString,
		tSize	nPos,
		tSize	nLength = `InvalidPos`
	)

inline

This function inserts a string into the cStringA object.

If the nPos is greater than the length of the string or less than 0, strString will NOT be appended. A nLength of <= -1 inserts the complete string.

Parameters

strToInsertString	[in] The string to insert.
nPos	[in] The zero-based index of the position where to insert the string. If nPos is greater than the length of the String, the strString will not be appended!
nLength	[in] The amount of characters of the string that should be inserted.

Returns: A copy of the resulting string.

Definition at line 640 of file string.h.

References string_base< storageT >::Append(), string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, and string_base< storageT >::m_oStorageBuffer.

Referenced by string_base< storageT >::Insert().

◆ Insert() [2/2]

_myType& Insert	(	const tChar *	pToInsertString,
		tSize	nPos,
		tSize	nLength = `InvalidPos`
	)

inline

This function inserts a string into the cStringA object.

If the nPos is greater than the length of the string or less than 0, pString will NOT be appended. A nLength of <= -1 inserts the complete string.

Parameters

pToInsertString	[in] Pointer to the string to insert.
nPos	[in] The zero-based index of the position where to insert the string. If nPos is greater than the length of the String, the strString will not be appended !
nLength	[in] The amount of characters of the string that should be inserted.

Returns: A copy of the resulting string.

Definition at line 666 of file string.h.

References string_base< storageT >::Insert().

◆ IsEmpty()

tBool IsEmpty ( ) const

inline

This function checks if the string object is empty.

Returns: tBool value that is true, if the string object is empty.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 447 of file string.h.

References cStringUtil::GetLength(), and string_base< storageT >::GetPtr().

◆ IsEqual()

tBool IsEqual	(	const _myType &	strCmp,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function checks if the two strings are equal (case sensitive)

Parameters

strCmp	[in] The other string used for comparison.
nPos	[in] The start index of the strCmp/str1 to compare from.
nLength	[in] The amount of characters that should be compared.

Returns: tTrue if the two strings are equal, tFalse otherwise

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 761 of file string.h.

References string_base< storageT >::Compare(), tFalse, and tTrue.

Referenced by string_base< storageT >::EndsWith(), cDDLCompareFunctor< T >::operator()(), and A_UTILS_NS::operator==().

◆ IsEqualNoCase()

tBool IsEqualNoCase	(	const _myType &	strCmp,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function checks if the two strings are equal (case insensitive)

Parameters

strCmp	[in] The other string used for comparison.
nPos	[in] The start index of the strCmp/str1 to compare from .
nLength	[in] The amount of characters that should be compared.

Returns: tTrue if the two strings are equal tFalse otherwise

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 779 of file string.h.

References cStringUtil::CompareNoCase(), string_base< storageT >::GetPtr(), tFalse, and tTrue.

Referenced by string_base< storageT >::EndsWith().

◆ IsFloat()

tBool IsFloat ( ) const

inline

Check if string content represents a floating point value.

Allowed float format [whitespace] [sign] [digits] [.digits] [ {d | D | e | E }[sign]digits] sign is either plus (+) or minus (-) digits (0123456789) The decimal digits may be followed by an exponent, which consists of an introductory letter (d, D, e, or E) and an optionally signed decimal integer.

Returns: tBool tTrue if the value represents a floating point number

Definition at line 1980 of file string.h.

References string_base< storageT >::GetPtr(), and cStringUtil::IsFloat().

Referenced by string_base< storageT >::IsNumeric().

◆ IsInteger()

tBool IsInteger ( ) const

inline

Check if string content represents an integer value.

A hex number will not be identified as an integer value.

and - may precede the number. White spaces are not allowed.

Returns: tBool, tTrue if the value is an integer number

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1963 of file string.h.

References string_base< storageT >::GetPtr(), and cStringUtil::IsInteger().

Referenced by string_base< storageT >::IsNumeric().

◆ IsNotEmpty()

tBool IsNotEmpty ( ) const

inline

This function checks if the string object is not empty.

Returns: tBool value that is true, if the string object is not empty.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 460 of file string.h.

References string_base< storageT >::IsEmpty().

Referenced by string_base< storageT >::SplitToken().

◆ IsNotEqual()

tBool IsNotEqual	(	const _myType &	strCmp,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function checks if the two strings are not equal (case sensitive)

Parameters

strCmp	[in] The other string used for comparison.
nPos	[in] The start index to compare from.
nLength	[in] The amount of characters that should be compared.

Returns: tTrue if the two strings are not equal tFalse otherwise

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 796 of file string.h.

References string_base< storageT >::Compare(), tFalse, and tTrue.

Referenced by A_UTILS_NS::operator!=().

◆ IsNotEqualNoCase()

tBool IsNotEqualNoCase	(	const _myType &	strCmp,
		tSize	nPos = `0`,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function checks if the two strings are not equal (case insensitive)

Parameters

strCmp	[in] The other string used for comparison.
nPos	[in] The start index to compare from.
nLength	[in] The amount of characters that should be compared.

Returns: tTrue if the two strings are not equal tFalse otherwise

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 814 of file string.h.

References string_base< storageT >::CompareNoCase(), tFalse, and tTrue.

◆ IsNumeric()

tBool IsNumeric ( ) const

inline

Check if string content represents a numeric value.

◆ Left()

_myType Left ( tSize nLength ) const

inline

Extracts the first (that is, leftmost) nLength characters from the cStringA object and returns a copy of the extracted substring.

If nLength exceeds the string length, then the entire string is extracted. If the nLength is less than zero, an empty string will bee returned. Left is similar to the Basic LEFT$ function (except that indexes are zero-based).

Parameters

nLength [in] The number of characters to extract from this cStringA object.

Returns: A cStringA object that contains a copy of the specified range of characters. Note that the returned cStringA object may be empty.

Definition at line 1454 of file string.h.

References string_base< storageT >::SubString().

◆ LeftTrim()

tVoid LeftTrim ( tBool bNumTrim = tFalse )

inline

This function removes leading whitespace characters or leading zero characters from a cStringA object.

It does not remove a '0' directly left to a comma or decimal point. " abc" -> "abc", "000045" -> "45", "000.45" -> "0.45"

Parameters

bNumTrim [in] Whether or not to trim leading '0'

Returns: tVoid

Definition at line 1628 of file string.h.

References string_base< storageT >::begin(), string_base< storageT >::Delete(), string_base< storageT >::end(), cStringUtil::IsOneOf(), cStringUtil::IsWhiteChar(), tFalse, and tTrue.

Referenced by string_base< storageT >::NumTrim(), and string_base< storageT >::Trim().

◆ Mid()

_myType Mid	(	tSize	nPos,
		tSize	nLength = `InvalidPos`
	)		const

inline

This function extracts a substring of length nLength characters from the cStringA object, starting at position nPos (zero-based).

The function returns a copy of the extracted substring. Mid is similar to the Basic MID$ function (except that indexes are zero-based).

Parameters

nPos	[in] The zero-based index of the first character in the cStringA object that is to be included in the extracted substring.
nLength	[in] The number of characters to extract from this cStringA object. If this parameter is not supplied, then the remainder of the string is extracted.

Returns: A cStringA object that contains a copy of the specified range of characters. Note that the returned cStringA object may be empty.

Definition at line 1421 of file string.h.

References string_base< storageT >::Empty, string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, string_base< storageT >::IsEmpty(), and string_base< storageT >::SubString().

Referenced by string_base< storageT >::Replace(), string_base< storageT >::Split(), and string_base< storageT >::SplitToken().

◆ NumTrim()

tVoid NumTrim ( )

inline

This function removes whitespace and redundant zero characters from a cStringA object.

The object will be trimmed on the right and on the left side.

Returns: tVoid

Definition at line 1676 of file string.h.

References string_base< storageT >::Delete(), string_base< storageT >::FindToken(), string_base< storageT >::GetAt(), string_base< storageT >::GetLength(), string_base< storageT >::InvalidPos, string_base< storageT >::IsEmpty(), cStringUtil::IsOneOf(), string_base< storageT >::LeftTrim(), string_base< storageT >::RightTrim(), tFalse, and tTrue.

◆ operator const tChar *()

operator const tChar * ( ) const

inline

This useful casting operator provides an efficient method to access the null- terminated C string contained in a cStringA object.

No characters are copied; only a pointer is returned. Be careful with this operator. If you change a cStringA object after you have obtained the character pointer, you may cause a reallocation of memory that invalidates the pointer.

Returns: A character pointer to the string data.

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1214 of file string.h.

References string_base< storageT >::GetPtr().

◆ operator!=() [1/2]

tBool operator!= ( const _myType & strString ) const

inline

Checks if a string not equals the cStringA object.

Parameters

[in] strString The string.

Returns: True if strings are not equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1326 of file string.h.

◆ operator!=() [2/2]

tBool operator!= ( const tChar * pString ) const

inline

Checks if a string does not equal the cStringA object.

Parameters

pString The string.

Returns: True if strings are not equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1257 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ operator+=()

const _myType& operator+= ( const _myType & strString )

inline

The += concatenation operator joins characters to the end of this string.

You should be aware that out-of-memory errors may occur whenever you use this concatenation operator because new storage may be allocated for characters added to this cStringA object.

Parameters

strString [in] second cStringA object to be concatenated.

Returns: Reference to accessed cStringA object.

Definition at line 1234 of file string.h.

References string_base< storageT >::Append().

◆ operator<() [1/2]

tBool operator< ( const _myType & strString ) const

inline

Checks if a string is lexicographically greater than the cStringA object.

Parameters

[in] strString The string.

Returns: True if strString is greater

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1337 of file string.h.

◆ operator<() [2/2]

tBool operator< ( const tChar * pString ) const

inline

Checks if a string is lexicographically greater than the cStringA object.

Parameters

[in] pString The string.

Returns: True if pString is greater

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1268 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ operator<=() [1/2]

tBool operator<= ( const _myType & strString ) const

inline

Checks if a string is lexicographically greater than or equal to the cStringA object.

Parameters

[in] strString The string.

Returns: True if strString is greater or equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1360 of file string.h.

◆ operator<=() [2/2]

tBool operator<= ( const tChar * pString ) const

inline

Checks if a string is lexicographically greater than or equal to the cStringA object.

Parameters

[in] pString The string.

Returns: True if pString is greater or equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1291 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ operator=() [1/5]

string_base& operator= ( _myType && strValue )

inline

The cString assignment (=) operator assigns a new value to the existing cString object.

Parameters

strValue [in] string value to be assigned.

Returns: Reference to cString object.

Definition at line 107 of file string.h.

◆ operator=() [2/5]

string_base& operator= ( const _myType & strValue )

inline

The cString assignment (=) operator assigns a new value to the existing cString object.

Parameters

strValue [in] string value to be assigned.

Returns: Reference to cString object.

Definition at line 89 of file string.h.

◆ operator=() [3/5]

string_base& operator= ( const _StorageType & strValue )

inline

The cString assignment (=) operator assigns a new value to the existing cString object.

Parameters

strValue [in] string value to be assigned.

Returns: Reference to cString object.

Definition at line 134 of file string.h.

References string_base< storageT >::m_oStorageBuffer.

◆ operator=() [4/5]

string_base& operator= ( const tChar & strValue )

inline

The cString assignment (=) operator assigns a new value to the existing cString object.

Parameters

strValue [in] string value to be assigned.

Returns: Reference to cString object.

Definition at line 145 of file string.h.

◆ operator=() [5/5]

string_base& operator= ( const tChar * strValue )

inline

The cString assignment (=) operator assigns a new value to the existing cString object.

Parameters

strValue [in] string value to be assigned.

Returns: Reference to cString object.

Definition at line 166 of file string.h.

◆ operator==() [1/2]

tBool operator== ( const _myType & strString ) const

inline

Checks if a string equals the cStringA object.

Parameters

[in] strString The string.

Returns: True if strings are equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1315 of file string.h.

◆ operator==() [2/2]

tBool operator== ( const tChar * pString ) const

inline

Checks if a string equals the cStringA object.

Parameters

[in] pString The string.

Returns: True if strings are equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1246 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ operator>() [1/2]

tBool operator> ( const _myType & strString ) const

inline

Checks if a string is lexicographically smaller than the cStringA object.

Parameters

[in] strString The string.

Returns: True if strString is smaller

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1348 of file string.h.

◆ operator>() [2/2]

tBool operator> ( const tChar * pString ) const

inline

Checks if a string is lexicographically smaller than the cStringA object.

Parameters

[in] pString The string.

Returns: True if pString is smaller

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1279 of file string.h.

References cStringUtil::Compare(), and string_base< storageT >::GetPtr().

◆ operator>=() [1/2]

tBool operator>= ( const _myType & strString ) const

inline

Checks if a string is lexicographically smaller than or equal to the cStringA object.

Parameters

[in] strString The string.

Returns: True if strString is smaller or equal

This method is real-time safe.\nSee @ref page_real_time_safe.\n

Definition at line 1372 of file string.h.