FbxStringListT< Type > Class Template Reference

#include <fbxstringlist.h>

Class Description

template<class Type>
class FbxStringListT< Type >

Base class of FbxStringList.

Definition at line 50 of file fbxstringlist.h.

Public Member Functions
Operation With The Array
int	AddItem (Type *pItem)
	Append a item at the end of the array. More...
int	InsertItemAt (int pIndex, Type *pItem)
	Insert a item in the array. More...
Type *	GetItemAt (int pIndex) const
	Access item at given index. More...
int	FindItem (Type *pItem) const
	Find first matching item. More...
Constructor and Destructor
	FbxStringListT ()
	Default constructor. More...
virtual	~FbxStringListT ()
	Destructor. More...
void	RemoveLast ()
	Remove the item at the end of the array and delete the associated object. More...
int	GetCount () const
	Get number of items in the array. More...
FbxString &	operator[] (int pIndex)
	Access the string in the item at given index. More...
FbxHandle	GetReferenceAt (int pIndex) const
	Access the value of reference in the item at given index. More...
void	SetReferenceAt (int pIndex, FbxHandle pRef)
	Set the value of reference at given index. More...
char *	GetStringAt (int pIndex) const
	Access the pointer of string at given index. More...
virtual bool	SetStringAt (int pIndex, const char *pString)
	Set string at given index. More...
int	Find (Type &pItem) const
	Find first matching item. More...
int	FindIndex (FbxHandle pReference) const
	Find first matching item which has the same reference as given parameter. More...
int	FindIndex (const char *pString) const
	Find first matching item in array whose string address is the same as given pointer. More...
FbxHandle	FindReference (const char *pString) const
	Access the value of reference of the first matching item in array whose string address is the same as given pointer. More...
bool	Remove (Type &pItem)
	Remove first matching item. More...
bool	Remove (const char *pString)
	Remove first matching item in array whose string address is the same as given pointer. More...
bool	RemoveIt (Type &pItem)
	Remove first matching item. More...
void	Sort ()
	Sort the array by the string of every item,not case sensitive. More...
void *	FindEqual (const char *pString) const
	Find first matching item which has the same string as given parameter,not case sensitive. More...
void *	FindCaseSensitive (const char *pString) const
	Find first matching item which has the same string as given parameter, case sensitive. More...
int	Add (const char *pString, FbxHandle pItem=0)
	Add a new item at the end of array. More...
virtual int	InsertAt (int pIndex, const char *pString, FbxHandle pItem=0)
virtual void	RemoveAt (int pIndex)
	Remove the item at the given position in the array and delete the associated object. More...
virtual void	Clear ()
	Delete the array. More...
virtual void	GetText (FbxString &pText) const
	Get the string of all the item. More...
virtual int	SetText (const char *pList)
	Clear the array and set the array's new items with the substring separated by '~' from the given string. More...

Protected Attributes
FbxArray< Type * >	mList

Constructor & Destructor Documentation

FbxStringListT()

FbxStringListT ( )

inline

Default constructor.

Definition at line 90 of file fbxstringlist.h.

    {
    }

~FbxStringListT()

virtual ~FbxStringListT ( )

inlinevirtual

Destructor.

Definition at line 95 of file fbxstringlist.h.

{ Clear(); }

Member Function Documentation

AddItem()

int AddItem ( Type *  pItem )

inline

Append a item at the end of the array.

Returns

Index of appended pointer.

Definition at line 64 of file fbxstringlist.h.

{ return mList.Add( pItem ); }

InsertItemAt()

int InsertItemAt ( int  pIndex, Type *  pItem  )

inline

Insert a item in the array.

Parameters

pIndex	Position where to insert the item.
pItem	Item to insert.

Returns

Position of the inserted item in the array.

Remarks

If the given index is out of range, the pointer is appended at the end of the array.

Definition at line 72 of file fbxstringlist.h.

{ return mList.InsertAt( pIndex, pItem ); }

GetItemAt()

Type* GetItemAt ( int  pIndex ) const

inline

Access item at given index.

Definition at line 75 of file fbxstringlist.h.

{ return mList[pIndex]; }

FindItem()

int FindItem ( Type *  pItem ) const

inline

Find first matching item.

Returns

Index of first matching item found or -1 if there is no matching element.

Definition at line 80 of file fbxstringlist.h.

{ return mList.Find( pItem ); }

RemoveLast()

void RemoveLast ( )

inline

Remove the item at the end of the array and delete the associated object.

Definition at line 99 of file fbxstringlist.h.

{ RemoveAt( mList.GetCount()-1 ); }

GetCount()

int GetCount ( ) const

inline

Get number of items in the array.

Returns

The number of items in the array.

Definition at line 104 of file fbxstringlist.h.

{ return mList.GetCount(); }

operator[]()

FbxString& operator[] ( int  pIndex )

inline

Access the string in the item at given index.

Definition at line 107 of file fbxstringlist.h.

{ return mList[pIndex]->mString; }

GetReferenceAt()

FbxHandle GetReferenceAt ( int  pIndex ) const

inline

Access the value of reference in the item at given index.

Definition at line 110 of file fbxstringlist.h.

{ return mList[pIndex]->mReference; }

SetReferenceAt()

void SetReferenceAt ( int  pIndex, FbxHandle  pRef  )

inline

Set the value of reference at given index.

Definition at line 113 of file fbxstringlist.h.

{ mList[pIndex]->mReference = pRef; }

GetStringAt()

char* GetStringAt ( int  pIndex ) const

inline

Access the pointer of string at given index.

Definition at line 116 of file fbxstringlist.h.

{ if (pIndex<mList.GetCount()) return mList[pIndex]->mString.Buffer(); else return NULL; }

SetStringAt()

virtual bool SetStringAt ( int  pIndex, const char *  pString  )

inlinevirtual

Set string at given index.

Definition at line 119 of file fbxstringlist.h.

    { 
        if (pIndex<mList.GetCount()) 
        {
            mList[pIndex]->mString = pString; 
            return true;
        } else return false; 
    }

Find()

int Find ( Type &  pItem ) const

inline

Find first matching item.

Returns

Index of first matching item found or -1 if there is no matching element.

Definition at line 132 of file fbxstringlist.h.

    { 
        for (int Count=0; Count<mList.GetCount(); Count++) {
            if (mList[Count]==&pItem) {
                return Count;
            }
        }
        return -1;
    }

FindIndex() [1/2]

int FindIndex ( FbxHandle  pReference ) const

inline

Find first matching item which has the same reference as given parameter.

Returns

Index of first matching item found or -1 if there is no matching element.

Definition at line 146 of file fbxstringlist.h.

    { 
        for (int Count=0; Count<mList.GetCount(); Count++) {
            if (mList[Count]->mReference==pReference) {
                return Count;
            }
        }
        return -1;
    }

FindIndex() [2/2]

int FindIndex ( const char *  pString ) const

inline

Find first matching item in array whose string address is the same as given pointer.

Returns

Index of first matching item found or -1 if there is no matching element.

Definition at line 160 of file fbxstringlist.h.

    { 
        for (int lCount=0; lCount<mList.GetCount(); lCount++) {
            if (mList[lCount]->mString==pString) {
                return lCount;
            }
        }
        return -1;
    }

FindReference()

FbxHandle FindReference ( const char *  pString ) const

inline

Access the value of reference of the first matching item in array whose string address is the same as given pointer.

Returns

The value of reference of the first matching item found or NULL if there is no matching element.

Definition at line 175 of file fbxstringlist.h.

    {
    int lIndex = FindIndex( pString );
        if (lIndex!=-1) {
            return mList[lIndex]->mReference;
        }
        return 0; // NULL
    }

Remove() [1/2]

bool Remove ( Type &  pItem )

inline

Remove first matching item.

Definition at line 185 of file fbxstringlist.h.

    {
    int lIndex = Find( pItem );
        if (lIndex>=0) {
            RemoveAt( lIndex );
            return true;
        }
        return false;
    }

Remove() [2/2]

bool Remove ( const char *  pString )

inline

Remove first matching item in array whose string address is the same as given pointer.

Definition at line 196 of file fbxstringlist.h.

    {
    int lIndex = FindIndex( pString );
        if (lIndex>=0) {
            RemoveAt( lIndex );
            return true;
        }
        return false;
    }

RemoveIt()

bool RemoveIt ( Type &  pItem )

inline

Remove first matching item.

Definition at line 207 of file fbxstringlist.h.

    {
    int lIndex = Find( pItem );
        if (lIndex>=0) {
            RemoveAt( lIndex );
            return true;
        }
        return false;
    }

Sort()

void Sort ( )

inline

Sort the array by the string of every item,not case sensitive.

Definition at line 218 of file fbxstringlist.h.

    {
        qsort( &(mList.GetArray()[0]),mList.GetCount(),sizeof(FbxStringListItem*),FbxCompareStringListSort );
    }

FindEqual()

void* FindEqual ( const char *  pString ) const

inline

Find first matching item which has the same string as given parameter,not case sensitive.

Returns

the pointer of matching item found or NULL if there is no matching element.

Remarks

To cast the returned pointer to the FbxStringListItem you need a double indirection: (FbxStringListItem**)

Definition at line 228 of file fbxstringlist.h.

    {
    FbxStringListItem Key(pString);  
    
        if (mList.GetCount() != 0)
        {
            return bsearch ( &Key, &(mList.GetArray()[0]),mList.GetCount(),sizeof(FbxStringListItem*),FbxCompareStringListFindEqual );
        }
        else
        {
            return NULL ;
        }
    }

FindCaseSensitive()

void* FindCaseSensitive ( const char *  pString ) const

inline

Find first matching item which has the same string as given parameter, case sensitive.

Returns

the pointer of matching item found or NULL if there is no matching element.

Remarks

To cast the returned pointer to the FbxStringListItem you need a double indirection: (FbxStringListItem**)

Definition at line 247 of file fbxstringlist.h.

    {
    FbxStringListItem Key(pString);  
    
        if (mList.GetCount() != 0)
        {
            return bsearch ( &Key, &(mList.GetArray()[0]),mList.GetCount(),sizeof(FbxStringListItem*), FbxCompareCaseSensitiveStringList);
        }
        else
        {
            return NULL ;
        }
    
    }

Add()

int Add ( const char *  pString, FbxHandle  pItem = 0  )

inline

Add a new item at the end of array.

Definition at line 264 of file fbxstringlist.h.

    { 
        return InsertAt( mList.GetCount(),pString,pItem ); 
    }

InsertAt()

virtual int InsertAt ( int  pIndex, const char *  pString, FbxHandle  pItem = 0  )

inlinevirtual

Definition at line 269 of file fbxstringlist.h.

    { 
        return mList.InsertAt( pIndex,FbxNew< Type >( pString,(FbxHandle)pItem )); 
    }

RemoveAt()

virtual void RemoveAt ( int  pIndex )

inlinevirtual

Remove the item at the given position in the array and delete the associated object.

Parameters

pIndex

Position of the item to remove.

Remarks

If the index is not valid, nothing is performed. Otherwise, the item is removed from the array and the items are shifted to fill the empty slot.

Definition at line 280 of file fbxstringlist.h.

    { 
        FbxDelete(mList.RemoveAt(pIndex));
    }

Clear()

virtual void Clear ( )

inlinevirtual

Delete the array.

Definition at line 286 of file fbxstringlist.h.

    {
        FbxArrayDelete(mList);
    }

GetText()

virtual void GetText ( FbxString &  pText ) const

inlinevirtual

Get the string of all the item.

Returns

The text of string, each item's string separated by '~'.

Definition at line 294 of file fbxstringlist.h.

    {
        int lCount;
        for (lCount=0; lCount<mList.GetCount(); lCount++) 
        {
            pText += mList[lCount]->mString;
            if (lCount<mList.GetCount()-1) 
            {               
                pText += "~";               
            }
        }
    }

SetText()

virtual int SetText ( const char *  pList )

inlinevirtual

Clear the array and set the array's new items with the substring separated by '~' from the given string.

Parameters

pList

The string which used to generate the new items.

Returns

The last index of the item in the new array.

Remarks

The number of items in the new array is the same as the number of substrings, and the string of each item is decided by the content of each substring.

Definition at line 313 of file fbxstringlist.h.

    {
    int     lPos=0, lOldPos = 0;
    int     lLastIndex=0;
    FbxString   lName=pList;

        Clear();
        for (lPos=0; lName.Buffer()[lPos]!=0; lPos++) {
            if (lName.Buffer()[lPos]=='~') {
                lName.Buffer()[lPos]=0;
                lLastIndex = Add(lName.Buffer()+lOldPos);
                lOldPos=lPos+1;
            }
        }

        if(lOldPos != lPos)
        {
            lLastIndex = Add(lName.Buffer()+lOldPos);
        }
        return lLastIndex;
    } 

Member Data Documentation

mList

FbxArray<Type*> mList

protected

Definition at line 53 of file fbxstringlist.h.

---

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

• fbxsdk/core/base/fbxstringlist.h