|
libSBML Python API
5.18.0
|
|
libSBML Python API
5.18.0
|
Class for managing lists of ModelCreator objects.
This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.
This class is necessary because of programming language differences between Python and the underlying C++ core of libSBML's implementation. It would of course be preferable to have a common list type for all lists returned by libSBML (e.g., lists of ModelCreator objects, lists of ModelCreator objects, etc.). However, this is currently impossible to achieve given the way the underlying C++ lists are implemented.
As a result of this incompatibility, libSBML must implement the Python versions of the lists in another way. The approach taken is to define specialized list types for each kind of object that needs a list; that is, ModelCreatorList for ModelCreator objects, ModelCreatorList for ModelCreator objects, and a few others. These list objects provide the same kind of functionality that the underlying C++ generic lists provide (such as get(), add(), remove(), etc.).
Public Member Functions | |
| def | __init__ (self) |
| Explicit constructor for this list. More... | |
| def | add (self, args) |
Adds the given ModelCreator object item to this list. More... | |
| def | get (self, args) |
| Returns the nth ModelCreator object from this list. More... | |
| def | getSize (self) |
| Returns the number of items in this list. More... | |
| def | prepend (self, args) |
Adds the ModelCreator object item to the beginning of this list. More... | |
| def | remove (self, args) |
| Removes the nth ModelCreator object from this list and returns it. More... | |
| def libsbml.ModelCreatorList.__init__ | ( | self | ) |
Explicit constructor for this list.
__init__() string
In most circumstances, callers will obtain an ModelCreatorList object from a call to a libSBML method that returns the list. However, the constructor is provided in case callers need to construct the lists themselves.
| def libsbml.ModelCreatorList.add | ( | self, | |
| args | |||
| ) |
Adds the given ModelCreator object item to this list.
add(ModelCreator item)
| item | the ModelCreator object to add to add |
| def libsbml.ModelCreatorList.get | ( | self, | |
| args | |||
| ) |
Returns the nth ModelCreator object from this list.
get() ModelCreator
If the index number n is greater than the size of the list (as indicated by getSize()), then this method returns None.
| n | the index number of the item to get, with indexing beginning at number 0. |
| def libsbml.ModelCreatorList.getSize | ( | self | ) |
Returns the number of items in this list.
getSize() long
| def libsbml.ModelCreatorList.prepend | ( | self, | |
| args | |||
| ) |
Adds the ModelCreator object item to the beginning of this list.
prepend(ModelCreator item)
| item | a pointer to the item to be prepended. |
| def libsbml.ModelCreatorList.remove | ( | self, | |
| args | |||
| ) |
Removes the nth ModelCreator object from this list and returns it.
remove(long n) ModelCreator
Callers can use getSize() to find out the length of the list. If n > getSize(), this method returns None and does not delete anything.
| n | the index number of the item to remove |
n