Inheritance diagram for libsbml.ModelHistory:

Detailed Description

MIRIAM-compliant data about a model's history.

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 optional 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 ModelHistory class as a convenient high-level interface for working with model history data.

Model histories in SBML consist of one or more model creators, a single date of creation, and one or more modification dates. The overall XML form of this data takes the following form:

 <dc:creator>
   <rdf:Bag>
     <rdf:li rdf:parseType='Resource'>
       +++
       <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 name</vCard:Orgname>
       </vCard:ORG>
       +++
     </rdf:li>
     ...
   </rdf:Bag>
 </dc:creator>
 <dcterms:created rdf:parseType='Resource'>
   <dcterms:W3CDTF>creation date</dcterms:W3CDTF>
 </dcterms:created>
 <dcterms:modified rdf:parseType='Resource'>
   <dcterms:W3CDTF>modification date</dcterms:W3CDTF>
 </dcterms:modified>
 ...

In the template above, the underlined portions are optional, the symbol +++ is a placeholder for either no content or valid XML content that is not defined by the annotation scheme, and the ellipses ... are placeholders for zero or more elements of the same form as the immediately preceding element. The various placeholders for content, namely family name, given name, email address, organization, creation date, and modification date are data that can be filled in using the various methods on the ModelHistory class described below.

See also: ModelCreator; Date

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	addCreator (self, mc)
	Adds a copy of a ModelCreator object to the list of 'model creator' values stored in this ModelHistory object. More...

def	addModifiedDate (self, date)
	Adds a copy of a Date object to the list of 'modified date' values stored in this ModelHistory object. More...

def	clone (self)
	Creates and returns a deep copy of this ModelHistory object. More...

def	getCreatedDate (self)
	Returns the 'creation date' portion of this ModelHistory object. More...

def	getCreator (self, n)
	Get the nth ModelCreator object stored in this ModelHistory object. More...

def	getListCreators (self)
	Returns the list of ModelCreator objects stored in this ModelHistory object. More...

def	getListModifiedDates (self)
	Returns the list of 'modified date' values (as Date objects) stored in this ModelHistory object. More...

def	getModifiedDate (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getNumCreators (self)
	Get the number of ModelCreator objects stored in this ModelHistory object. More...

def	getNumModifiedDates (self)
	Get the number of Date objects in this ModelHistory object's list of 'modified dates'. More...

def	hasRequiredAttributes (self)
	Predicate returning `True` if all the required elements for this ModelHistory object have been set. More...

def	isSetCreatedDate (self)
	Predicate returning `True` or `False` depending on whether this ModelHistory's 'creation date' is set. More...

def	isSetModifiedDate (self)
	Predicate returning `True` or `False` depending on whether this ModelHistory's 'modified date' is set. More...

def	setCreatedDate (self, date)
	Sets the creation date of this ModelHistory object. More...

def	setModifiedDate (self, date)
	Sets the modification date of this ModelHistory object. More...

Constructor & Destructor Documentation

def libsbml.ModelHistory.__init__	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

__init__()   ModelHistory
__init__(ModelHistory orig)   ModelHistory

Each variant is described separately below.

Method variant with the following signature:

ModelHistory(ModelHistory orig)

Copy constructor; creates a copy of this ModelHistory object.

Parameters

orig	the object to copy.

Method variant with the following signature:

ModelHistory()

Creates a new ModelHistory object.

Member Function Documentation

def libsbml.ModelHistory.addCreator	(	self,
		mc
	)

Adds a copy of a ModelCreator object to the list of 'model creator' values stored in this ModelHistory object.

addCreator(ModelCreator mc)   int

In the MIRIAM format for annotations, there can be multiple model creators. The libSBML ModelHistory class supports this by storing a list of 'model creator' values.

Parameters

mc	the ModelCreator to add.

Returns

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

def libsbml.ModelHistory.addModifiedDate	(	self,
		date
	)

Adds a copy of a Date object to the list of 'modified date' values stored in this ModelHistory object.

addModifiedDate(Date date)   int

In the MIRIAM format for annotations, there can be multiple modification dates. The libSBML ModelHistory class supports this by storing a list of 'modified date' values.

Parameters

date	a Date object representing the 'modified date' that should be added to this ModelHistory object.

Returns

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

def libsbml.ModelHistory.clone ( self )

Creates and returns a deep copy of this ModelHistory object.

clone()   ModelHistory

Returns: the (deep) copy of this ModelHistory object.

def libsbml.ModelHistory.getCreatedDate ( self )

Returns the 'creation date' portion of this ModelHistory object.

getCreatedDate()   Date

Returns: a Date object representing the creation date stored in this ModelHistory object.

def libsbml.ModelHistory.getCreator	(	self,
		n
	)

Get the nth ModelCreator object stored in this ModelHistory object.

getCreator(long  n)   ModelCreator

In the MIRIAM format for annotations, there can be multiple model creators. The libSBML ModelHistory class supports this by storing a list of 'model creator' values.

Returns: the nth ModelCreator object or None if no such object exists.

def libsbml.ModelHistory.getListCreators ( self )

Returns the list of ModelCreator objects stored in this ModelHistory object.

getListCreators()   List *

In the MIRIAM format for annotations, there can be multiple model creators. The libSBML ModelHistory class supports this by storing a list of 'model creator' values.

Returns: the list of ModelCreator objects.

def libsbml.ModelHistory.getListModifiedDates ( self )

Returns the list of 'modified date' values (as Date objects) stored in this ModelHistory object.

getListModifiedDates()   List *

In the MIRIAM format for annotations, there can be multiple modification dates. The libSBML ModelHistory class supports this by storing a list of 'modified date' values.

Returns: the list of modification dates for this ModelHistory object.

def libsbml.ModelHistory.getModifiedDate	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getModifiedDate()   Date
getModifiedDate(long  n)   Date

Each variant is described separately below.

Method variant with the following signature:

getModifiedDate()

Returns the 'modified date' portion of this ModelHistory object.

Note that in the MIRIAM format for annotations, there can be multiple modification dates. The libSBML ModelHistory class supports this by storing a list of 'modified date' values. If this ModelHistory object contains more than one 'modified date' value in the list, this method will return the first one in the list.

Returns: a Date object representing the date of modification stored in this ModelHistory object.

Method variant with the following signature:

getModifiedDate(long n)

Get the nth Date object in the list of 'modified date' values stored in this ModelHistory object.

In the MIRIAM format for annotations, there can be multiple modification dates. The libSBML ModelHistory class supports this by storing a list of 'modified date' values.

Returns: the nth Date in the list of ModifiedDates of this ModelHistory or None if no such object exists.

def libsbml.ModelHistory.getNumCreators ( self )

Get the number of ModelCreator objects stored in this ModelHistory object.

getNumCreators()   long

In the MIRIAM format for annotations, there can be multiple model creators. The libSBML ModelHistory class supports this by storing a list of 'model creator' values.

Returns: the number of ModelCreators objects.

def libsbml.ModelHistory.getNumModifiedDates ( self )

Get the number of Date objects in this ModelHistory object's list of 'modified dates'.

getNumModifiedDates()   long

In the MIRIAM format for annotations, there can be multiple modification dates. The libSBML ModelHistory class supports this by storing a list of 'modified date' values.

Returns: the number of ModifiedDates in this ModelHistory.

def libsbml.ModelHistory.hasRequiredAttributes ( self )

Predicate returning True if all the required elements for this ModelHistory object have been set.

hasRequiredAttributes()   bool

The required elements for a ModelHistory object are 'created name', 'modified date', and at least one 'model creator'.

Returns: a boolean value indicating whether all the required elements for this object have been defined.

def libsbml.ModelHistory.isSetCreatedDate ( self )

Predicate returning True or False depending on whether this ModelHistory's 'creation date' is set.

isSetCreatedDate()   bool

Returns: True if the creation date value of this ModelHistory is set, False otherwise.

def libsbml.ModelHistory.isSetModifiedDate ( self )

Predicate returning True or False depending on whether this ModelHistory's 'modified date' is set.

isSetModifiedDate()   bool

Returns: True if the modification date value of this ModelHistory object is set, False otherwise.

def libsbml.ModelHistory.setCreatedDate	(	self,
		date
	)

Sets the creation date of this ModelHistory object.

setCreatedDate(Date date)   int

Parameters

date	a Date object representing the date to which the 'created date' portion of this ModelHistory should be set.

Returns

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

def libsbml.ModelHistory.setModifiedDate	(	self,
		date
	)

Sets the modification date of this ModelHistory object.

setModifiedDate(Date date)   int

Parameters

date	a Date object representing the date to which the 'modified date' portion of this ModelHistory should be set.

Returns

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

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation