libsbml.ModelCreator Class Reference
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). For the model creator, this form involves the use of parts of the vCard representation. LibSBML provides the ModelCreator class as a convenience high-level interface for working with model creator data. Objects of class ModelCreator can be used to store and carry around creator data within a program, and the various methods in this object class let callers manipulate the different parts of the model creator representation.
The different parts of a model creator definition
The ModelCreator class mirrors the structure of the MIRIAM model creator annotations in SBML. The following template illustrates these different fields when they are written in XML form:
div class='fragment'> lt;vCard:N rdf:parseType='Resource'>
nbsp; <vCard:Family>family name</vCard:Family>
nbsp; <vCard:Given>given name</vCard:Given>
lt;/vCard:N>
..
lt;vCard:EMAIL>email address</vCard:EMAIL>
..
lt;vCard:ORG rdf:parseType='Resource'>
nbsp; <vCard:Orgname>organization</vCard:Orgname>
lt;/vCard:ORG>
/div>
Each of the separate data values family name, given name, email address, and organization can be set and retrieved via corresponding methods in the ModelCreator class. These methods are documented in more detail below.
Public Member Functions | |
| 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 |
Member Function Documentation
| def libsbml.ModelCreator.clone | ( | self | ) |
Python method signature(s):
clone()ModelCreator
Creates and returns a copy of this ModelCreator.
- Returns:
- a (deep) copy of this ModelCreator.
| def libsbml.ModelCreator.getEmail | ( | self | ) |
Python method signature(s):
getEmail()
Returns the 'email' stored in this ModelCreator object.
- Returns:
- email from the ModelCreator.
| def libsbml.ModelCreator.getFamilyName | ( | self | ) |
Python method signature(s):
getFamilyName()
Returns the 'family name' stored in this ModelCreator object.
- Returns:
- the 'family name' portion of the ModelCreator object.
| def libsbml.ModelCreator.getGivenName | ( | self | ) |
Python method signature(s):
getGivenName()
Returns the 'given name' stored in this ModelCreator object.
- Returns:
- the 'given name' portion of the ModelCreator object.
| def libsbml.ModelCreator.getOrganisation | ( | self | ) |
Python method signature(s):
getOrganisation()
(Alternate spelling) Returns the 'organization' stored in this ModelCreator object.
- Note:
- This function is an alias of getOrganization().
- Returns:
- organization from the ModelCreator.
- See also:
- getOrganization()
| def libsbml.ModelCreator.getOrganization | ( | self | ) |
Python method signature(s):
getOrganization()
Returns the 'organization' stored in this ModelCreator object.
- Returns:
- organization from the ModelCreator.
| def libsbml.ModelCreator.hasRequiredAttributes | ( | self | ) |
Python method signature(s):
hasRequiredAttributes()
Predicate returning true if all the required elements for this ModelCreator object have been set.
The only required elements for a ModelCreator object are the 'family name' and 'given name'.
- Returns:
- a boolean value indicating whether all the required elements for this object have been defined.
| def libsbml.ModelCreator.isSetEmail | ( | self | ) |
Python method signature(s):
isSetEmail()
Predicate returning true or false depending on whether this ModelCreator's 'email' part is set.
- Returns:
trueif the email of this ModelCreator is set,falseotherwise.
| def libsbml.ModelCreator.isSetFamilyName | ( | self | ) |
Python method signature(s):
isSetFamilyName()
Predicate returning true or false depending on whether this ModelCreator's 'family name' part is set.
- Returns:
trueif the familyName of this ModelCreator is set,falseotherwise.
| def libsbml.ModelCreator.isSetGivenName | ( | self | ) |
Python method signature(s):
isSetGivenName()
Predicate returning true or false depending on whether this ModelCreator's 'given name' part is set.
- Returns:
trueif the givenName of this ModelCreator is set,falseotherwise.
| def libsbml.ModelCreator.isSetOrganisation | ( | self | ) |
Python method signature(s):
isSetOrganisation()
(Alternate spelling) Predicate returning true or false depending on whether this ModelCreator's 'organization' part is set.
- Note:
- This function is an alias of isSetOrganization().
- Returns:
trueif the organization of this ModelCreator is set,falseotherwise.
- See also:
- isSetOrganization()
| def libsbml.ModelCreator.isSetOrganization | ( | self | ) |
Python method signature(s):
isSetOrganization()
Predicate returning true or false depending on whether this ModelCreator's 'organization' part is set.
- Returns:
trueif the organization of this ModelCreator is set,falseotherwise.
| def libsbml.ModelCreator.setEmail | ( | self, | ||
| args | ||||
| ) |
Python method signature(s):
setEmail(string email)
Sets the 'email' portion of this ModelCreator object.
- 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:
| def libsbml.ModelCreator.setFamilyName | ( | self, | ||
| args | ||||
| ) |
Python method signature(s):
setFamilyName(string familyName)
Sets the 'family name' portion of this ModelCreator object.
- 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:
| def libsbml.ModelCreator.setGivenName | ( | self, | ||
| args | ||||
| ) |
Python method signature(s):
setGivenName(string givenName)
Sets the 'given name' portion of this ModelCreator object.
- 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:
| def libsbml.ModelCreator.setOrganisation | ( | self, | ||
| args | ||||
| ) |
Python method signature(s):
setOrganisation(string organization)
(Alternate spelling) Sets the 'organization' portion of this ModelCreator object.
- Parameters:
-
organization a string representing the organization of the ModelCreator.
- Note:
- This function is an alias of setOrganization(string organization).
- Returns:
- integer value indicating success/failure of the function. The possible values returned by this function are:
- See also:
- setOrganization()
| def libsbml.ModelCreator.setOrganization | ( | self, | ||
| args | ||||
| ) |
Python method signature(s):
setOrganization(string organization)
Sets the 'organization' portion of this ModelCreator object.
- 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:
| def libsbml.ModelCreator.unsetEmail | ( | self | ) |
Python method signature(s):
unsetEmail()
Unsets the 'email' portion of this ModelCreator object.
- Returns:
- integer value indicating success/failure of the function. The possible values returned by this function are:
| def libsbml.ModelCreator.unsetFamilyName | ( | self | ) |
Python method signature(s):
unsetFamilyName()
Unsets the 'family name' portion of this ModelCreator object.
- Returns:
- integer value indicating success/failure of the function. The possible values returned by this function are:
| def libsbml.ModelCreator.unsetGivenName | ( | self | ) |
Python method signature(s):
unsetGivenName()
Unsets the 'given name' portion of this ModelCreator object.
- Returns:
- integer value indicating success/failure of the function. The possible values returned by this function are:
| def libsbml.ModelCreator.unsetOrganisation | ( | self | ) |
Python method signature(s):
unsetOrganisation()
(Alternate spelling) Unsets the 'organization' portion of this ModelCreator object.
- 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:
- See also:
- unsetOrganization()
| def libsbml.ModelCreator.unsetOrganization | ( | self | ) |
Python method signature(s):
unsetOrganization()
Unsets the 'organization' portion of this ModelCreator object.
- Returns:
- integer value indicating success/failure of the function. The possible values returned by this function are:
