Inheritance diagram for libsbmlcs.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
int	addCreator (ModelCreator mc)
	Adds a copy of a ModelCreator object to the list of 'model creator' values stored in this ModelHistory object. More...

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

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

virtual void	Dispose ()

override bool	Equals (Object sb)

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

ModelCreator	getCreator (long n)
	Get the nth ModelCreator object stored in this ModelHistory object. More...

override int	GetHashCode ()

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

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

Date	getModifiedDate ()
	Returns the 'modified date' portion of this ModelHistory object. More...

Date	getModifiedDate (long n)
	Get the nth Date object in the list of 'modified date' values stored in this ModelHistory object. More...

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

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

bool	hasBeenModified ()

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

bool	isSetCreatedDate ()
	Predicate returning `true` or `false` depending on whether this ModelHistory's 'creation date' is set. More...

bool	isSetModifiedDate ()
	Predicate returning `true` or `false` depending on whether this ModelHistory's 'modified date' is set. More...

	ModelHistory ()
	Creates a new ModelHistory object. More...

	ModelHistory (ModelHistory orig)
	Copy constructor; creates a copy of this ModelHistory object. More...

void	resetModifiedFlags ()

int	setCreatedDate (Date date)
	Sets the creation date of this ModelHistory object. More...

int	setModifiedDate (Date date)
	Sets the modification date of this ModelHistory object. More...

Static Public Member Functions
static bool	operator!= (ModelHistory lhs, ModelHistory rhs)

static bool	operator== (ModelHistory lhs, ModelHistory rhs)

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.ModelHistory.ModelHistory ( )

Creates a new ModelHistory object.

libsbmlcs.ModelHistory.ModelHistory ( ModelHistory orig )

Copy constructor; creates a copy of this ModelHistory object.

Parameters

orig	the object to copy.

Member Function Documentation

int libsbmlcs.ModelHistory.addCreator ( ModelCreator mc )

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

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:

int libsbmlcs.ModelHistory.addModifiedDate ( Date date )

Adds a copy of a Date object to 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.

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:

ModelHistory libsbmlcs.ModelHistory.clone ( )

Creates and returns a deep copy of this ModelHistory object.

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

virtual void libsbmlcs.ModelHistory.Dispose ( )

virtual

override bool libsbmlcs.ModelHistory.Equals ( Object sb )

Date libsbmlcs.ModelHistory.getCreatedDate ( )

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

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

ModelCreator libsbmlcs.ModelHistory.getCreator ( long n )

Get the nth ModelCreator object stored in this ModelHistory object.

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 null if no such object exists.

override int libsbmlcs.ModelHistory.GetHashCode ( )

ModelCreatorList libsbmlcs.ModelHistory.getListCreators ( )

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

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.

DateList libsbmlcs.ModelHistory.getListModifiedDates ( )

Returns the list of 'modified date' values (as Date objects) 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 list of modification dates for this ModelHistory object.

Date libsbmlcs.ModelHistory.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.

Date libsbmlcs.ModelHistory.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 null if no such object exists.

long libsbmlcs.ModelHistory.getNumCreators ( )

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

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.

long libsbmlcs.ModelHistory.getNumModifiedDates ( )

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

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.

bool libsbmlcs.ModelHistory.hasBeenModified ( )

bool libsbmlcs.ModelHistory.hasRequiredAttributes ( )

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

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.

bool libsbmlcs.ModelHistory.isSetCreatedDate ( )

Predicate returning true or false depending on whether this ModelHistory's 'creation date' is set.

Returns: true if the creation date value of this ModelHistory is set, false otherwise.

bool libsbmlcs.ModelHistory.isSetModifiedDate ( )

Predicate returning true or false depending on whether this ModelHistory's 'modified date' is set.

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

static bool libsbmlcs.ModelHistory.operator!=	(	ModelHistory	lhs,
		ModelHistory	rhs
	)

static

static bool libsbmlcs.ModelHistory.operator==	(	ModelHistory	lhs,
		ModelHistory	rhs
	)

static

void libsbmlcs.ModelHistory.resetModifiedFlags ( )

int libsbmlcs.ModelHistory.setCreatedDate ( Date date )

Sets the creation date of this ModelHistory object.

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:

int libsbmlcs.ModelHistory.setModifiedDate ( Date date )

Sets the modification date of this ModelHistory object.

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:

Member Data Documentation

bool libsbmlcs.ModelHistory.swigCMemOwn

protected

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation