libSBML Python API
5.10.0
|
{core}
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 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:
<vCard:N rdf:parseType='Resource'> <vCard:Family>family name</vCard:Family> <vCard:Given>given name</vCard:Given> </vCard:N> ... <vCard:EMAIL>email address</vCard:EMAIL> ... <vCard:ORG rdf:parseType='Resource'> <vCard:Orgname>organization</vCard:Orgname> </vCard:ORG>
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 |
def libsbml.ModelCreator.clone | ( | self | ) |
{core}
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 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:
<vCard:N rdf:parseType='Resource'> <vCard:Family>family name</vCard:Family> <vCard:Given>given name</vCard:Given> </vCard:N> ... <vCard:EMAIL>email address</vCard:EMAIL> ... <vCard:ORG rdf:parseType='Resource'> <vCard:Orgname>organization</vCard:Orgname> </vCard:ORG>
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. Python method signature(s):
clone(ModelCreator self)ModelCreator
Creates and returns a copy of this ModelCreator.
def libsbml.ModelCreator.getEmail | ( | self | ) |
Python method signature(s):
getEmail(ModelCreator self)string
Returns the 'email' stored in this ModelCreator object.
def libsbml.ModelCreator.getFamilyName | ( | self | ) |
Python method signature(s):
getFamilyName(ModelCreator self)string
Returns the 'family name' stored in this ModelCreator object.
def libsbml.ModelCreator.getGivenName | ( | self | ) |
Python method signature(s):
getGivenName(ModelCreator self)string
Returns the 'given name' stored in this ModelCreator object.
def libsbml.ModelCreator.getOrganisation | ( | self | ) |
Python method signature(s):
getOrganisation(ModelCreator self)string
(Alternate spelling) Returns the 'organization' stored in this ModelCreator object.
def libsbml.ModelCreator.getOrganization | ( | self | ) |
Python method signature(s):
getOrganization(ModelCreator self)string
Returns the 'organization' stored in this ModelCreator object.
def libsbml.ModelCreator.hasRequiredAttributes | ( | self | ) |
Python method signature(s):
hasRequiredAttributes(ModelCreator self)bool
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'.
def libsbml.ModelCreator.isSetEmail | ( | self | ) |
Python method signature(s):
isSetEmail(ModelCreator self)bool
Predicate returning True
or False
depending on whether this ModelCreator's 'email' part is set.
True
if the email of this ModelCreator is set, False
otherwise. def libsbml.ModelCreator.isSetFamilyName | ( | self | ) |
Python method signature(s):
isSetFamilyName(ModelCreator self)bool
Predicate returning True
or False
depending on whether this ModelCreator's 'family name' part is set.
True
if the familyName of this ModelCreator is set, False
otherwise. def libsbml.ModelCreator.isSetGivenName | ( | self | ) |
Python method signature(s):
isSetGivenName(ModelCreator self)bool
Predicate returning True
or False
depending on whether this ModelCreator's 'given name' part is set.
True
if the givenName of this ModelCreator is set, False
otherwise. def libsbml.ModelCreator.isSetOrganisation | ( | self | ) |
Python method signature(s):
isSetOrganisation(ModelCreator self)bool
(Alternate spelling) Predicate returning True
or False
depending on whether this ModelCreator's 'organization' part is set.
True
if the organization of this ModelCreator is set, False
otherwise.def libsbml.ModelCreator.isSetOrganization | ( | self | ) |
Python method signature(s):
isSetOrganization(ModelCreator self)bool
Predicate returning True
or False
depending on whether this ModelCreator's 'organization' part is set.
True
if the organization of this ModelCreator is set, False
otherwise. def libsbml.ModelCreator.setEmail | ( | self, | |
args | |||
) |
Python method signature(s):
setEmail(ModelCreator self, string email)int
Sets the 'email' portion of this ModelCreator object.
a string representing the email of the ModelCreator. |
def libsbml.ModelCreator.setFamilyName | ( | self, | |
args | |||
) |
Python method signature(s):
setFamilyName(ModelCreator self, string familyName)int
Sets the 'family name' portion of this ModelCreator object.
familyName | a string representing the familyName of the ModelCreator. |
def libsbml.ModelCreator.setGivenName | ( | self, | |
args | |||
) |
Python method signature(s):
setGivenName(ModelCreator self, string givenName)int
Sets the 'given name' portion of this ModelCreator object.
givenName | a string representing the givenName of the ModelCreator. |
def libsbml.ModelCreator.setOrganisation | ( | self, | |
args | |||
) |
Python method signature(s):
setOrganisation(ModelCreator self, string organization)int
(Alternate spelling) Sets the 'organization' portion of this ModelCreator object.
organization | a string representing the organization of the ModelCreator. |
def libsbml.ModelCreator.setOrganization | ( | self, | |
args | |||
) |
Python method signature(s):
setOrganization(ModelCreator self, string organization)int
Sets the 'organization' portion of this ModelCreator object.
organization | a string representing the organization of the ModelCreator. |
def libsbml.ModelCreator.unsetEmail | ( | self | ) |
Python method signature(s):
unsetEmail(ModelCreator self)int
Unsets the 'email' portion of this ModelCreator object.
def libsbml.ModelCreator.unsetFamilyName | ( | self | ) |
Python method signature(s):
unsetFamilyName(ModelCreator self)int
Unsets the 'family name' portion of this ModelCreator object.
def libsbml.ModelCreator.unsetGivenName | ( | self | ) |
Python method signature(s):
unsetGivenName(ModelCreator self)int
Unsets the 'given name' portion of this ModelCreator object.
def libsbml.ModelCreator.unsetOrganisation | ( | self | ) |
Python method signature(s):
unsetOrganisation(ModelCreator self)int
(Alternate spelling) Unsets the 'organization' portion of this ModelCreator object.
def libsbml.ModelCreator.unsetOrganization | ( | self | ) |
Python method signature(s):
unsetOrganization(ModelCreator self)int
Unsets the 'organization' portion of this ModelCreator object.