FBPropertyStringList Class Reference


Detailed Description

   # Supported list protocol methods:    
    len(propertyStringList)
    component= propertyStringList[0]
    propertyStringList[0] = my_string
 
    if my_string in propertyStringList:
       print "it is contained!"

    del propertyStringList[0]
Inheritance diagram for FBPropertyStringList:

List of all members.

Public Member Functions

int __len__ ()
 Returns the number of elements.
str __getitem__ (int pIndex)
 Returns the ith component Corresponds to python: print v[1].
 __setitem__ (int pIndex, str pValue)
 Sets the ith components Corresponds to python: v[1] = my_component.
bool __contains__ (str pValue)
 Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:
 append (str pValue)
 Append new str at end of list.
int count ()
 Returns the number of elements.
 insert (int pIndex, str pValue)
 Insert a new element in list.
 remove (int pIndex)
 Remove an element in list.
 removeall ()
 Remove all elements of list.
str pop ()
 Remove last element of list.
str pop (int pIndex)
 Remove an element in list.
int findFromReference (int pReference)
 Find the index of an element from its attached reference.
 setReferenceAt (int pReference)
 Sets the reference value of an object.
int getReferenceAt (int pIndex)
 Retrieve the reference of an object at ith position.

Member Function Documentation

int __len__ ( )

Returns the number of elements.

Corresponds to python: len(object)

Returns:
number of elements in list.

Reimplemented from FBPropertyList.

str __getitem__ ( int  pIndex)

Returns the ith component Corresponds to python: print v[1].

Parameters:
pIndexIndex of the components to get (0 to 2)
Returns:
str component value.

Reimplemented from FBPropertyList.

__setitem__ ( int  pIndex,
str  pValue 
)

Sets the ith components Corresponds to python: v[1] = my_component.

Parameters:
pIndexIndex of the components to set
pValuea str to set
bool __contains__ ( str  pValue)

Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:

Parameters:
pValueComponent to check for inclusion
Returns:
Is the String contained or not?
append ( str  pValue)

Append new str at end of list.

Parameters:
pValueto append
int count ( )

Returns the number of elements.

Corresponds to python: del propertyList[2]

Returns:
number of elements in list.
insert ( int  pIndex,
str  pValue 
)

Insert a new element in list.

Parameters:
pIndexIndex where to insert string
pValueString to append
remove ( int  pIndex)

Remove an element in list.

Parameters:
pIndexIndex where to remove element.
removeall ( )

Remove all elements of list.

str pop ( )

Remove last element of list.

Returns:
Returns the element that was removed.
str pop ( int  pIndex)

Remove an element in list.

Parameters:
pIndexIndex where to remove element.
Returns:
Returns the element that was removed.
int findFromReference ( int  pReference)

Find the index of an element from its attached reference.

Parameters:
pReferenceReference of searched object.
Returns:
Returns the index of the element corresponding to reference.
setReferenceAt ( int  pReference)

Sets the reference value of an object.

Parameters:
pReferenceReference of the object.
int getReferenceAt ( int  pIndex)

Retrieve the reference of an object at ith position.

Parameters:
pIndexIndex of the object to find reference.
Returns:
Returns the reference of the object.

FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList
FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList FBPropertyStringList