FbxString Class Reference

#include <fbxstring.h>

Class Description

Utility class to manipulate strings.

Examples:

Definition at line 66 of file fbxstring.h.

Constructors and Destructor
	FbxString ()
	Default constructor. More...
	FbxString (const FbxString &pString)
	Copy constructor. More...
	FbxString (const char *pString)
	String constructor. More...
	FbxString (char pChar, size_t pNbRepeat=1)
	Character constructor. More...
	FbxString (const char *pCharPtr, size_t pLength)
	String constructor with maximum length. More...
	FbxString (const int pValue)
	Integer constructor. More...
	FbxString (const float pValue)
	Float constructor. More...
	FbxString (const double pValue)
	Double constructor. More...
	~FbxString ()
	Destructor. More...

Buffer Access and Validation
size_t	GetLen () const
	Get string length like "C" strlen(). More...
size_t	Size () const
	Get string length like "C" strlen(). More...
bool	IsEmpty () const
	Return true if string length equal zero. More...
FbxString &	Clear ()
	Discard the content of the string. More...
char &	operator[] (int pIndex)
	Access by reference. More...
char	operator[] (int pIndex) const
	Access by copy. More...
char *	Buffer ()
	Non-const buffer access. More...
const char *	Buffer () const
	Const buffer access. More...

String Operations
const FbxString &	operator= (const FbxString &pString)
	FbxString assignment operator. More...
const FbxString &	operator= (char pChar)
	Character assignment operator. More...
const FbxString &	operator= (const char *pString)
	String assignment operator. More...
const FbxString &	operator= (int pValue)
	Int assignment operator. More...
const FbxString &	operator= (float pValue)
	Float assignment operator. More...
const FbxString &	operator= (double pValue)
	Double assignment operator. More...
const FbxString &	operator+= (const FbxString &pString)
	FbxString append. More...
const FbxString &	operator+= (char pChar)
	Character append. More...
const FbxString &	operator+= (const char *pString)
	String append. More...
const FbxString &	operator+= (int pValue)
	Integer append. More...
const FbxString &	operator+= (float pValue)
	Float append. More...
const FbxString &	operator+= (double pValue)
	Double append. More...
bool	operator== (const FbxString &pString) const
	Equality operator. More...
bool	operator!= (const FbxString &pString) const
	Inequality operator. More...
bool	operator< (const FbxString &pString) const
	Inferior to operator. More...
bool	operator<= (const FbxString &pString) const
	Inferior or equal to operator. More...
bool	operator>= (const FbxString &pString) const
	Superior or equal to operator. More...
bool	operator> (const FbxString &pString) const
	Superior to operator. More...
bool	operator== (const char *pString) const
	Equality operator. More...
bool	operator!= (const char *pString) const
	Inequality operator. More...
bool	operator< (const char *pString) const
	Inferior to operator. More...
bool	operator<= (const char *pString) const
	Inferior or equal to operator. More...
bool	operator>= (const char *pString) const
	Superior or equal to operator. More...
bool	operator> (const char *pString) const
	Superior to operator. More...
	operator const char * () const
	Cast operator. More...
const FbxString &	Copy (const char *pString, size_t pLength)
	String assignment function with maximum length. More...
const FbxString &	Append (const char *pString, size_t pLength)
	Append as "C" strncat(). More...
int	Compare (const char *pString) const
	Compare as "C" strcmp(). More...
int	CompareNoCase (const char *pString) const
	Compare as "C" stricmp(). More...
void	Swap (FbxString &pString)
	Swap the contents of two strings. More...
FbxString	Upper () const
	Uppercase conversion. More...
FbxString	Lower () const
	Lowercase conversion. More...
FbxString	operator+ (const FbxString &pString1, const FbxString &pString2)
	FbxString concatenation. More...
FbxString	operator+ (const FbxString &pString, char pChar)
	Character concatenation. More...
FbxString	operator+ (char pChar, const FbxString &pString)
	Character concatenation. More...
FbxString	operator+ (const FbxString &pString1, const char *pString2)
	String concatenation. More...
FbxString	operator+ (const char *pString1, const FbxString &pString2)
	String concatenation. More...
FbxString	operator+ (const FbxString &pString, int pValue)
	Integer concatenation. More...
FbxString	operator+ (int pValue, const FbxString &pString)
	Integer concatenation. More...
FbxString	operator+ (const FbxString &pString, float pValue)
	Float concatenation. More...
FbxString	operator+ (float pValue, const FbxString &pString)
	Float concatenation. More...
FbxString	operator+ (const FbxString &pString, double pValue)
	Double concatenation. More...

Substring Extraction
FbxString	Mid (size_t pFirst, size_t pCount) const
	Extract middle string for a given length. More...
FbxString	Mid (size_t pFirst) const
	Extract middle string up to the end. More...
FbxString	Left (size_t pCount) const
	Extract left string. More...
FbxString	Right (size_t pCount) const
	Extract right string. More...

Padding
enum	EPaddingType { eRight, eLeft, eBoth }
	Padding types. More...
FbxString	Pad (EPaddingType pPadding, size_t pLen, char pCar=' ') const
	Add padding characters. More...
FbxString	UnPad (EPaddingType pPadding, char pCar='\0') const
	Remove padding characters. More...

Search
int	Find (char pChar, size_t pStartPosition=0) const
	Look for a single character match, like "C" strchr(). More...
int	Find (const char *pStrSub, size_t pStartPosition=0) const
	Look for a substring match, like "C" strstr(). More...
int	ReverseFind (char pChar) const
	Look for the last occurrence of character in string, like "C" strrchr(). More...
int	FindOneOf (const char *pStrCharSet, size_t pStartPosition=0) const
	Look for a single character match, like "C" strpbrk(). More...
bool	FindAndReplace (const char *pFind, const char *pReplaceBy, size_t pStartPosition=0)
	Replace a substring. More...
bool	ReplaceAll (const char *pFind, const char *pReplaceBy)
	Replace all occurrence of a substring. More...
bool	ReplaceAll (char pFind, char pReplaceBy)
	Replace all occurrence of character to find by replacement character. More...

Token Extraction
int	GetTokenCount (const char *pSpans) const
	Get number of tokens. More...
FbxString	GetToken (int pTokenIndex, const char *pSpans) const
	Get token at given index. More...

Member Enumeration Documentation

enum EPaddingType

Padding types.

• eRight
• eLeft
• eBoth

Enumerator
eRight
eLeft
eBoth

Definition at line 355 of file fbxstring.h.

{eRight, eLeft, eBoth};

Constructor & Destructor Documentation

FbxString

(

)

Default constructor.

FbxString

(

const FbxString &

pString

)

Copy constructor.

Parameters

pString

The FbxString to be copied.

FbxString

(

const char *

pString

)

String constructor.

Parameters

pString

The string used to construct FbxString.

FbxString	(	char	pChar,
		size_t	pNbRepeat = 1
	)

Character constructor.

Parameters

pChar	The character used to construct FbxString.
pNbRepeat	The number of times to repeat the character. Default value is 1

FbxString	(	const char *	pCharPtr,
		size_t	pLength
	)

String constructor with maximum length.

Parameters

pCharPtr	The string used to construct FbxString.
pLength	Maximum length.

FbxString

(

const int

pValue

)

Integer constructor.

Parameters

pValue

The int value used to construct FbxString.

FbxString

(

const float

pValue

)

Float constructor.

Parameters

pValue

The float value used to construct FbxString.

FbxString

(

const double

pValue

)

Double constructor.

Parameters

pValue

The double value used to construct FbxString.

~FbxString

(

)

Destructor.

Member Function Documentation

size_t GetLen

(

)

const

Get string length like "C" strlen().

Examples:

size_t Size

(

)

const

Get string length like "C" strlen().

bool IsEmpty

(

)

const

Return true if string length equal zero.

Examples:

FbxString& Clear

(

)

Discard the content of the string.

char& operator[]

(

int

pIndex

)

Access by reference.

Parameters

pIndex

The index.

Returns

The reference of the char at pIndex.

char operator[]

(

int

pIndex

)

const

Access by copy.

Parameters

pIndex

The index.

Returns

The char at pIndex.

char* Buffer

(

)

Non-const buffer access.

Examples:

const char* Buffer

(

)

const

Const buffer access.

const FbxString& operator=

(

const FbxString &

pString

)

FbxString assignment operator.

Parameters

pString

The FbxString to be assigned.

const FbxString& operator=

(

char

pChar

)

Character assignment operator.

Parameters

pChar

The character to be assigned.

const FbxString& operator=

(

const char *

pString

)

String assignment operator.

Parameters

pString

The string to be assigned.

const FbxString& operator=

(

int

pValue

)

Int assignment operator.

Parameters

pValue

The int value to be assigned.

const FbxString& operator=

(

float

pValue

)

Float assignment operator.

Parameters

pValue

The float value to be assigned.

const FbxString& operator=

(

double

pValue

)

Double assignment operator.

Parameters

pValue

The double value to be assigned.

const FbxString& operator+=

(

const FbxString &

pString

)

FbxString append.

Parameters

pString

The FbxString to be appended.

const FbxString& operator+=

(

char

pChar

)

Character append.

Parameters

pChar

The character to be appended.

const FbxString& operator+=

(

const char *

pString

)

String append.

Parameters

pString

The string to be appended.

const FbxString& operator+=

(

int

pValue

)

Integer append.

Parameters

pValue

The int value to be appended.

const FbxString& operator+=

(

float

pValue

)

Float append.

Parameters

pValue

The float value to be appended.

const FbxString& operator+=

(

double

pValue

)

Double append.

Parameters

pValue

The double value to be appended.

bool operator==

(

const FbxString &

pString

)

const

Equality operator.

Parameters

pString

The FbxString to be compared.

bool operator!=

(

const FbxString &

pString

)

const

Inequality operator.

Parameters

pString

The FbxString to be compared.

bool operator<

(

const FbxString &

pString

)

const

Inferior to operator.

Parameters

pString

The FbxString to be compared.

bool operator<=

(

const FbxString &

pString

)

const

Inferior or equal to operator.

Parameters

pString

The FbxString to be compared.

bool operator>=

(

const FbxString &

pString

)

const

Superior or equal to operator.

Parameters

pString

The FbxString to be compared.

bool operator>

(

const FbxString &

pString

)

const

Superior to operator.

Parameters

pString

The FbxString to be compared.

bool operator==

(

const char *

pString

)

const

Equality operator.

Parameters

pString

The string to be compared.

bool operator!=

(

const char *

pString

)

const

Inequality operator.

Parameters

pString

The string to be compared.

bool operator<

(

const char *

pString

)

const

Inferior to operator.

Parameters

pString

The string to be compared.

bool operator<=

(

const char *

pString

)

const

Inferior or equal to operator.

Parameters

pString

The string to be compared.

bool operator>=

(

const char *

pString

)

const

Superior or equal to operator.

Parameters

pString

The string to be compared.

bool operator>

(

const char *

pString

)

const

Superior to operator.

Parameters

pString

The string to be compared.

operator const char *

(

)

const

Cast operator.

const FbxString& Copy	(	const char *	pString,
		size_t	pLength
	)

String assignment function with maximum length.

Parameters

pString	The string to be assigned.
pLength	The maximum length of string to be assigned.

const FbxString& Append	(	const char *	pString,
		size_t	pLength
	)

Append as "C" strncat().

Parameters

pString	The string to be appended.
pLength	The length of chars to be appended.

int Compare

(

const char *

pString

)

const

Compare as "C" strcmp().

Parameters

pString

The string to be compared.

Examples:

int CompareNoCase

(

const char *

pString

)

const

Compare as "C" stricmp().

Parameters

pString

The string to be compared.

void Swap

(

FbxString &

pString

)

Swap the contents of two strings.

Parameters

pString

The FbxString to be swapped.

FbxString Upper

(

)

const

Uppercase conversion.

Examples:

FbxString Lower

(

)

const

Lowercase conversion.

FbxString Mid	(	size_t	pFirst,
		size_t	pCount
	)		const

Extract middle string for a given length.

Parameters

pFirst	The start index of FbxString to be extracted.
pCount	The length of sub-string to be extracted.

FbxString Mid

(

size_t

pFirst

)

const

Extract middle string up to the end.

Parameters

pFirst

The start index of FbxString to be extracted.

FbxString Left

(

size_t

pCount

)

const

Extract left string.

Parameters

pCount

The length of sub-string to be extracted.

Examples:

FbxString Right

(

size_t

pCount

)

const

Extract right string.

Parameters

pCount

The length of sub-string to be extracted.

Examples:

FbxString Pad	(	EPaddingType	pPadding,
		size_t	pLen,
		char	pCar = ' '
	)		const

Add padding characters.

Parameters

pPadding	The padding type.
pLen	The length limit of FbxString after padding.
pCar	The character to be padded.

FbxString UnPad	(	EPaddingType	pPadding,
		char	pCar = '\0'
	)		const

Remove padding characters.

Parameters

pPadding	The padding type.
pCar	The character to be padded.

Remarks

If pCar == '\0' the function will remove all the characters that are tested by isspace().

int Find	(	char	pChar,
		size_t	pStartPosition = 0
	)		const

Look for a single character match, like "C" strchr().

Parameters

pChar	The character to look for.
pStartPosition	Start position to look for.

Returns

Index or -1 if not found.

Examples:

int Find	(	const char *	pStrSub,
		size_t	pStartPosition = 0
	)		const

Look for a substring match, like "C" strstr().

Parameters

pStrSub	The substring to look for.
pStartPosition	Start position to look for.

Returns

Starting index or -1 if not found.

int ReverseFind

(

char

pChar

)

const

Look for the last occurrence of character in string, like "C" strrchr().

Parameters

pChar

The character to look for.

Returns

Index or -1 if not found.

int FindOneOf	(	const char *	pStrCharSet,
		size_t	pStartPosition = 0
	)		const

Look for a single character match, like "C" strpbrk().

Parameters

pStrCharSet	The character set.
pStartPosition	The start position.

Returns

Index or -1 if not found.

bool FindAndReplace	(	const char *	pFind,
		const char *	pReplaceBy,
		size_t	pStartPosition = 0
	)

Replace a substring.

Parameters

pFind	The substring to look for.
pReplaceBy	The string to replace by.
pStartPosition	The start position.

Returns

true if substring found and replaced.

bool ReplaceAll	(	const char *	pFind,
		const char *	pReplaceBy
	)

Replace all occurrence of a substring.

Parameters

pFind	The substring to look for.
pReplaceBy	The string to replace by.

Returns

true if something got replaced.

bool ReplaceAll	(	char	pFind,
		char	pReplaceBy
	)

Replace all occurrence of character to find by replacement character.

Parameters

pFind	The character to look for.
pReplaceBy	The character to replace by.

Returns

true if character found and replaced.

int GetTokenCount

(

const char *

pSpans

)

const

Get number of tokens.

Parameters

pSpans

The span

Returns

The number of tokens.

FbxString GetToken	(	int	pTokenIndex,
		const char *	pSpans
	)		const

Get token at given index.

Parameters

pTokenIndex	The token index.
pSpans	The span

Examples:

Friends And Related Function Documentation

FbxString operator+ ( const FbxString &  pString1, const FbxString &  pString2  )

friend

FbxString concatenation.

Parameters

pString1	FbxString 1 to be concatenated to FbxString 2.
pString2	FbxString 2 to be concatenated to FbxString 1

FbxString operator+ ( const FbxString &  pString, char  pChar  )

friend

Character concatenation.

Parameters

pString	FbxString to be concatenated to Character.
pChar	Character to be concatenated to FbxString

FbxString operator+ ( char  pChar, const FbxString &  pString  )

friend

Character concatenation.

Parameters

pChar	Character to be concatenated to FbxString
pString	FbxString to be concatenated to Character.

FbxString operator+ ( const FbxString &  pString1, const char *  pString2  )

friend

String concatenation.

Parameters

pString1	FbxString to be concatenated to String.
pString2	String to be concatenated to FbxString

FbxString operator+ ( const char *  pString1, const FbxString &  pString2  )

friend

String concatenation.

Parameters

pString1	String to be concatenated to FbxString
pString2	FbxString to be concatenated to String.

FbxString operator+ ( const FbxString &  pString, int  pValue  )

friend

Integer concatenation.

Parameters

pString	FbxString to be concatenated to Integer.
pValue	Integer to be concatenated to FbxString

FbxString operator+ ( int  pValue, const FbxString &  pString  )

friend

Integer concatenation.

Parameters

pValue	Integer to be concatenated to FbxString
pString	FbxString to be concatenated to Integer.

FbxString operator+ ( const FbxString &  pString, float  pValue  )

friend

Float concatenation.

Parameters

pString	FbxString to be concatenated to Float.
pValue	Float to be concatenated to FbxString

FbxString operator+ ( float  pValue, const FbxString &  pString  )

friend

Float concatenation.

Parameters

pValue	Float to be concatenated to FbxString
pString	FbxString to be concatenated to Float.

FbxString operator+ ( const FbxString &  pString, double  pValue  )

friend

Double concatenation.

Parameters

pString	FbxString to be concatenated to Double.
pValue	Double to be concatenated to FbxString

---

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

• fbxsdk/core/base/fbxstring.h