libsbml.SBO Class Reference
Detailed Description
Methods for interacting with Systems Biology Ontology (SBO) terms.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.
Definition at line 23706 of file libsbml.py.
Public Member Functions | |
| def | __init__ |
| def | checkTerm |
| def | intToString |
| def | isConservationLaw |
| def | isContinuousFramework |
| def | isDiscreteFramework |
| def | isEntity |
| def | isEvent |
| def | isFunctionalCompartment |
| def | isFunctionalEntity |
| def | isInteraction |
| def | isKineticConstant |
| def | isLogicalFramework |
| def | isMaterialEntity |
| def | isMathematicalExpression |
| def | isModellingFramework |
| def | isModifier |
| def | isObselete |
| def | isParticipant |
| def | isParticipantRole |
| def | isPhysicalParticipant |
| def | isProduct |
| def | isQuantitativeParameter |
| def | isRateLaw |
| def | isReactant |
| def | isSteadyStateExpression |
| def | stringToInt |
Public Attributes | |
| this | |
Member Function Documentation
| def libsbml.SBO.__init__ | ( | self | ) |
| def libsbml.SBO.checkTerm | ( | args | ) |
Python method signature(s):
checkTerm(string sboTerm)bool checkTerm(int sboTerm)
Checks the format of the given SBO integer portion.
- Returns:
- true if sboTerm is in the range [0 -- 9999999], false otherwise.
Definition at line 24149 of file libsbml.py.
| def libsbml.SBO.intToString | ( | args | ) |
Python method signature(s):
intToString(int sboTerm)
Returns the integer as a correctly formatted SBO string.
- Returns:
- the given integer sboTerm as a zero-padded seven digit string.
- Note:
- If the sboTerm is not in the correct range ([0 -- 9999999]), an empty string is returned.
Definition at line 24110 of file libsbml.py.
| def libsbml.SBO.isConservationLaw | ( | args | ) |
Python method signature(s):
isConservationLaw(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a ConservationLaw, false otherwise
Definition at line 23991 of file libsbml.py.
| def libsbml.SBO.isContinuousFramework | ( | args | ) |
Python method signature(s):
isContinuousFramework(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a ContinuousFramework, false otherwise
Definition at line 24042 of file libsbml.py.
| def libsbml.SBO.isDiscreteFramework | ( | args | ) |
Python method signature(s):
isDiscreteFramework(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a DiscreteFramework, false otherwise
Definition at line 24059 of file libsbml.py.
| def libsbml.SBO.isEntity | ( | args | ) |
Python method signature(s):
isEntity(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Entity, false otherwise
Definition at line 23940 of file libsbml.py.
| def libsbml.SBO.isEvent | ( | args | ) |
Python method signature(s):
isEvent(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Event, false otherwise
Definition at line 23872 of file libsbml.py.
| def libsbml.SBO.isFunctionalCompartment | ( | args | ) |
Python method signature(s):
isFunctionalCompartment(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a FunctionalCompartment, false otherwise
Definition at line 24025 of file libsbml.py.
| def libsbml.SBO.isFunctionalEntity | ( | args | ) |
Python method signature(s):
isFunctionalEntity(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a FunctionalEntity, false otherwise
Definition at line 23957 of file libsbml.py.
| def libsbml.SBO.isInteraction | ( | args | ) |
Python method signature(s):
isInteraction(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Interaction, false otherwise
Definition at line 23923 of file libsbml.py.
| def libsbml.SBO.isKineticConstant | ( | args | ) |
Python method signature(s):
isKineticConstant(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a KineticConstant, false otherwise
Definition at line 23787 of file libsbml.py.
| def libsbml.SBO.isLogicalFramework | ( | args | ) |
Python method signature(s):
isLogicalFramework(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a LogicalFramework, false otherwise
Definition at line 24076 of file libsbml.py.
| def libsbml.SBO.isMaterialEntity | ( | args | ) |
Python method signature(s):
isMaterialEntity(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a MaterialEntity, false otherwise
Definition at line 23974 of file libsbml.py.
| def libsbml.SBO.isMathematicalExpression | ( | args | ) |
Python method signature(s):
isMathematicalExpression(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a MathematicalExpression, false otherwise
Definition at line 23770 of file libsbml.py.
| def libsbml.SBO.isModellingFramework | ( | args | ) |
Python method signature(s):
isModellingFramework(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a ModellingFramework, false otherwise
Definition at line 23753 of file libsbml.py.
| def libsbml.SBO.isModifier | ( | args | ) |
Python method signature(s):
isModifier(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Modifier, false otherwise
Definition at line 23838 of file libsbml.py.
| def libsbml.SBO.isObselete | ( | args | ) |
Python method signature(s):
isObselete(unsigned int term)
Function for checking whether the SBO term is obselete.
- Returns:
- true if the term is-a Obsolete, false otherwise
Definition at line 24093 of file libsbml.py.
| def libsbml.SBO.isParticipant | ( | args | ) |
Python method signature(s):
isParticipant(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Participant, false otherwise
Definition at line 23906 of file libsbml.py.
| def libsbml.SBO.isParticipantRole | ( | args | ) |
Python method signature(s):
isParticipantRole(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a ParticipantRole, false otherwise
Definition at line 23736 of file libsbml.py.
| def libsbml.SBO.isPhysicalParticipant | ( | args | ) |
Python method signature(s):
isPhysicalParticipant(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a PhysicalParticipant, false otherwise
Definition at line 23889 of file libsbml.py.
| def libsbml.SBO.isProduct | ( | args | ) |
Python method signature(s):
isProduct(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Product, false otherwise
Definition at line 23821 of file libsbml.py.
| def libsbml.SBO.isQuantitativeParameter | ( | args | ) |
Python method signature(s):
isQuantitativeParameter(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a QuantitativeParameter, false otherwise
Definition at line 23719 of file libsbml.py.
| def libsbml.SBO.isRateLaw | ( | args | ) |
Python method signature(s):
isRateLaw(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a RateLaw, false otherwise
Definition at line 23855 of file libsbml.py.
| def libsbml.SBO.isReactant | ( | args | ) |
Python method signature(s):
isReactant(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a Reactant, false otherwise
Definition at line 23804 of file libsbml.py.
| def libsbml.SBO.isSteadyStateExpression | ( | args | ) |
Python method signature(s):
isSteadyStateExpression(unsigned int term)
Function for checking the SBO term is from correct part of SBO.
- Returns:
- true if the term is-a SteadyStateExpression, false otherwise
Definition at line 24008 of file libsbml.py.
| def libsbml.SBO.stringToInt | ( | args | ) |
Python method signature(s):
stringToInt(string sboTerm)
Returns the string as a correctly formatted SBO integer portion.
- Returns:
- the given string sboTerm as an integer. If the sboTerm is not in the correct format (a zero-padded, seven digit string), -1 is returned.
Definition at line 24130 of file libsbml.py.
Member Data Documentation
Definition at line 24173 of file libsbml.py.
