FbxString Class Reference
 
 
 
FbxString Class Reference

#include <fbxstring.h>


Class Description

List of all members.

Constructors and Destructor

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

Buffer Access and Validation

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

String Operations

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

Substring Extraction

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

Padding

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

Search

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

Token Extraction

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

Member Enumeration Documentation

Padding types.

  • eRight
  • eLeft
  • eBoth
Enumerator:
eRight 
eLeft 
eBoth 

Definition at line 371 of file fbxstring.h.


Constructor & Destructor Documentation

FbxString ( )

Default constructor.

FbxString ( const FbxString pStr )

Copy constructor.

Parameters:
pStr The FbxString to be copied.
FbxString ( const char *  pStr )

String constructor.

Parameters:
pStr 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

bool IsEmpty ( ) const

Return true if string length equal zero.

Examples:
ImportScene/DisplayCamera.cxx, and ImportScene/DisplayLight.cxx.
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.
const char* Buffer ( ) const

Const buffer access.

const FbxString& operator= ( const FbxString pStr )

FbxString assignment operator.

Parameters:
pStr 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 *  pStr )

String assignment operator.

Parameters:
pStr 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 pKStr )

FbxString append.

Parameters:
pKStr The FbxString to be appended.
const FbxString& operator+= ( char  pChar )

Character append.

Parameters:
pChar The character to be appended.
const FbxString& operator+= ( const char *  pStr )

String append.

Parameters:
pStr 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 pStr ) const

Equality operator.

Parameters:
pStr The FbxString to be compared.
bool operator!= ( const FbxString pStr ) const

Inequality operator.

Parameters:
pStr The FbxString to be compared.
bool operator< ( const FbxString pStr ) const

Inferior to operator.

Parameters:
pStr The FbxString to be compared.
bool operator<= ( const FbxString pStr ) const

Inferior or equal to operator.

Parameters:
pStr The FbxString to be compared.
bool operator>= ( const FbxString pStr ) const

Superior or equal to operator.

Parameters:
pStr The FbxString to be compared.
bool operator> ( const FbxString pStr ) const

Superior to operator.

Parameters:
pStr The FbxString to be compared.
bool operator== ( const char *  pStr ) const

Equality operator.

Parameters:
pStr The string to be compared.
bool operator!= ( const char *  pStr ) const

Inequality operator.

Parameters:
pStr The string to be compared.
bool operator< ( const char *  pStr ) const

Inferior to operator.

Parameters:
pStr The string to be compared.
bool operator<= ( const char *  pStr ) const

Inferior or equal to operator.

Parameters:
pStr The string to be compared.
bool operator>= ( const char *  pStr ) const

Superior or equal to operator.

Parameters:
pStr The string to be compared.
bool operator> ( const char *  pStr ) const

Superior to operator.

Parameters:
pStr The string to be compared.
operator const char * ( ) const

Cast operator.

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

String assignment function with maximum length.

Parameters:
pStr The string to be assigned.
pLength The maximum length of string to be assigned.
const FbxString& Append ( const char *  pStr,
size_t  pLength 
)

Append as "C" strncat().

Parameters:
pStr The string to be appended.
pLength The length of chars to be appended.
int Compare ( const char *  pStr ) const

Compare as "C" strcmp().

Parameters:
pStr The string to be compared.
Examples:
ViewScene/SetCamera.cxx.
int CompareNoCase ( const char *  pStr ) const

Compare as "C" stricmp().

Parameters:
pStr The string to be compared.
void Swap ( FbxString pStr )

Swap the contents of two strings.

Parameters:
pStr The FbxString to be swapped.
FbxString Upper ( ) const

Uppercase conversion.

Examples:
ViewScene/SceneContext.cxx.
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:
ImportScene/DisplayCamera.cxx, and ImportScene/DisplayMesh.cxx.
FbxString Right ( size_t  pCount ) const

Extract right string.

Parameters:
pCount The length of sub-string to be extracted.
Examples:
ViewScene/SceneContext.cxx.
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 ) const

Remove padding characters.

Parameters:
pPadding The padding type.
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:
Common/Common.cxx, ExportDocument/main.cxx, UI_Examples/Common/ImportExport.cxx, and UI_Examples/CubeCreator/SDK_Utility.cxx.
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:
MyOwnWriterReader/MyOwnReader.cxx.

Friends And Related Function Documentation

FBXSDK_DLL FbxString operator+ ( const FbxString pKStr1,
const FbxString pKStr2 
) [friend]

FbxString concatenation.

Parameters:
pKStr1 FbxString 1 to be concatenated to FbxString 2.
pKStr2 FbxString 2 to be concatenated to FbxString 1
FBXSDK_DLL FbxString operator+ ( const FbxString pKStr,
char  pChar 
) [friend]

Character concatenation.

Parameters:
pKStr FbxString to be concatenated to Character.
pChar Character to be concatenated to FbxString
FBXSDK_DLL FbxString operator+ ( const FbxString pKStr,
const char *  pStr 
) [friend]

String concatenation.

Parameters:
pKStr FbxString to be concatenated to String.
pStr String to be concatenated to FbxString
FBXSDK_DLL FbxString operator+ ( const FbxString pKStr,
int  pValue 
) [friend]

Integer concatenation.

Parameters:
pKStr FbxString to be concatenated to Integer.
pValue Integer to be concatenated to FbxString
FBXSDK_DLL FbxString operator+ ( const FbxString pKStr,
float  pValue 
) [friend]

Float concatenation.

Parameters:
pKStr FbxString to be concatenated to Float.
pValue Float to be concatenated to FbxString
FBXSDK_DLL FbxString operator+ ( const FbxString pKStr,
double  pValue 
) [friend]

Double concatenation.

Parameters:
pKStr FbxString to be concatenated to Double.
pValue Double to be concatenated to FbxString

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