libsbml.ModelCreator Class Reference

Inheritance diagram for libsbml.ModelCreator:

Inheritance graph
[legend]

List of all members.

Detailed Description

Representation of MIRIAM-compliant model creator data used in ModelHistory.

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.

The SBML specification beginning with Level 2 Version 2 defines a standard approach to recording model history and model creator information in a form that complies with MIRIAM ('Minimum Information Requested in the Annotation of biochemical Models', Nature Biotechnology, vol. 23, no. 12, Dec. 2005). LibSBML provides the ModelCreator class as a convenience high-level interface for working with model creator data.

Definition at line 32269 of file libsbml.py.


Public Member Functions

def __eq__
def __init__
def __ne__
def clone
def getEmail
def getFamilyName
def getGivenName
def getOrganisation
def getOrganization
def hasRequiredAttributes
def isSetEmail
def isSetFamilyName
def isSetGivenName
def isSetOrganisation
def isSetOrganization
def setEmail
def setFamilyName
def setGivenName
def setOrganisation
def setOrganization
def unsetEmail
def unsetFamilyName
def unsetGivenName
def unsetOrganisation
def unsetOrganization

Public Attributes

 this

Member Function Documentation

def libsbml.ModelCreator.__eq__ (   self,
  rhs 
)

Definition at line 32728 of file libsbml.py.

def libsbml.ModelCreator.__init__ (   self,
  args 
)

Python method signature(s): 

__init__(self)    ModelCreator
__init__(self, XMLNode creator)    ModelCreator
__init__(self, ModelCreator orig)    ModelCreator

Copy constructor; creates a copy of the ModelCreator.

Definition at line 32294 of file libsbml.py.

def libsbml.ModelCreator.__ne__ (   self,
  rhs 
)

Definition at line 32735 of file libsbml.py.

def libsbml.ModelCreator.clone (   self  ) 

Python method signature(s): 

clone(self)    ModelCreator

Creates and returns a copy of this ModelCreator.

Returns:
a (deep) copy of this ModelCreator.

Definition at line 32310 of file libsbml.py.

def libsbml.ModelCreator.getEmail (   self  ) 

Python method signature(s): 

getEmail(self)    string

Returns the email from the ModelCreator.

Returns:
email from the ModelCreator.

Definition at line 32355 of file libsbml.py.

def libsbml.ModelCreator.getFamilyName (   self  ) 

Python method signature(s): 

getFamilyName(self)    string

Returns the familyName from the ModelCreator.

Returns:
familyName from the ModelCreator.

Definition at line 32325 of file libsbml.py.

def libsbml.ModelCreator.getGivenName (   self  ) 

Python method signature(s): 

getGivenName(self)    string

Returns the givenName from the ModelCreator.

Returns:
givenName from the ModelCreator.

Definition at line 32340 of file libsbml.py.

def libsbml.ModelCreator.getOrganisation (   self  ) 

Python method signature(s): 

getOrganisation(self)    string

Returns the organization from the ModelCreator.

Note:
This function is an alias of getOrganization().
Returns:
organization from the ModelCreator.
See also:
getOrganization()

Definition at line 32385 of file libsbml.py.

def libsbml.ModelCreator.getOrganization (   self  ) 

Python method signature(s): 

getOrganization(self)    string

Returns the organization from the ModelCreator.

Returns:
organization from the ModelCreator.

Definition at line 32370 of file libsbml.py.

def libsbml.ModelCreator.hasRequiredAttributes (   self  ) 

Python method signature(s): 

hasRequiredAttributes(self)    bool

Unsets the organization of this ModelCreator.

Note:
This function is an alias of unsetOrganization().
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
See also:
unsetOrganization()
Deprecated:
libSBML internal

Definition at line 32703 of file libsbml.py.

def libsbml.ModelCreator.isSetEmail (   self  ) 

Python method signature(s): 

isSetEmail(self)    bool

Predicate returning true or false depending on whether this ModelCreator's email has been set.

Returns:
true if the email of this ModelCreator has been set, false otherwise.

Definition at line 32436 of file libsbml.py.

def libsbml.ModelCreator.isSetFamilyName (   self  ) 

Python method signature(s): 

isSetFamilyName(self)    bool

Predicate returning true or false depending on whether this ModelCreator's familyName has been set.

Returns:
true if the familyName of this ModelCreator has been set, false otherwise.

Definition at line 32404 of file libsbml.py.

def libsbml.ModelCreator.isSetGivenName (   self  ) 

Python method signature(s): 

isSetGivenName(self)    bool

Predicate returning true or false depending on whether this ModelCreator's givenName has been set.

Returns:
true if the givenName of this ModelCreator has been set, false otherwise.

Definition at line 32420 of file libsbml.py.

def libsbml.ModelCreator.isSetOrganisation (   self  ) 

Python method signature(s): 

isSetOrganisation(self)    bool

Predicate returning true or false depending on whether this ModelCreator's organization has been set.

Note:
This function is an alias of isSetOrganization().
Returns:
true if the organization of this ModelCreator has been set, false otherwise.
See also:
isSetOrganization()

Definition at line 32468 of file libsbml.py.

def libsbml.ModelCreator.isSetOrganization (   self  ) 

Python method signature(s): 

isSetOrganization(self)    bool

Predicate returning true or false depending on whether this ModelCreator's organization has been set.

Returns:
true if the organization of this ModelCreator has been set, false otherwise.

Definition at line 32452 of file libsbml.py.

def libsbml.ModelCreator.setEmail (   self,
  args 
)

Python method signature(s): 

setEmail(self, string email)    int

Sets the email

Parameters:
email a string representing the email of the ModelCreator.
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS

Definition at line 32530 of file libsbml.py.

def libsbml.ModelCreator.setFamilyName (   self,
  args 
)

Python method signature(s): 

setFamilyName(self, string familyName)    int

Sets the family name

Parameters:
familyName a string representing the familyName of the ModelCreator.
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS

Definition at line 32488 of file libsbml.py.

def libsbml.ModelCreator.setGivenName (   self,
  args 
)

Python method signature(s): 

setGivenName(self, string givenName)    int

Sets the given name

Parameters:
givenName a string representing the givenName of the ModelCreator.
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS

Definition at line 32509 of file libsbml.py.

def libsbml.ModelCreator.setOrganisation (   self,
  args 
)

Python method signature(s): 

setOrganisation(self, string organization)    int

Sets the organization

Parameters:
organization a string representing the organization of the ModelCreator.
Note:
This function is an alias of setOrganization(std.string organization).
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
See also:
setOrganization(std.string organization);

Definition at line 32573 of file libsbml.py.

def libsbml.ModelCreator.setOrganization (   self,
  args 
)

Python method signature(s): 

setOrganization(self, string organization)    int

Sets the organization

Parameters:
organization a string representing the organization of the ModelCreator.
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS

Definition at line 32551 of file libsbml.py.

def libsbml.ModelCreator.unsetEmail (   self  ) 

Python method signature(s): 

unsetEmail(self)    int

Unsets the email of this ModelCreator.

Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

Definition at line 32639 of file libsbml.py.

def libsbml.ModelCreator.unsetFamilyName (   self  ) 

Python method signature(s): 

unsetFamilyName(self)    int

Unsets the familyName of this ModelCreator.

Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

Definition at line 32599 of file libsbml.py.

def libsbml.ModelCreator.unsetGivenName (   self  ) 

Python method signature(s): 

unsetGivenName(self)    int

Unsets the givenName of this ModelCreator.

Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

Definition at line 32619 of file libsbml.py.

def libsbml.ModelCreator.unsetOrganisation (   self  ) 

Python method signature(s): 

unsetOrganisation(self)    int

Unsets the organization of this ModelCreator.

Note:
This function is an alias of unsetOrganization().
Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED
See also:
unsetOrganization()

Definition at line 32679 of file libsbml.py.

def libsbml.ModelCreator.unsetOrganization (   self  ) 

Python method signature(s): 

unsetOrganization(self)    int

Unsets the organization of this ModelCreator.

Returns:
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBSBML_OPERATION_SUCCESS
  • LIBSBML_OPERATION_FAILED

Definition at line 32659 of file libsbml.py.

Member Data Documentation

libsbml.ModelCreator.this

Definition at line 32309 of file libsbml.py.


SBML Team
http://www.sbml.org/
sbml-team@caltech.edu

HTML documentation generated on Thu Jan 21 16:56:17 2010 using Doxygen 1.5.8.