Inheritance diagram for libsbml.ModelCreator:

Detailed Description

MIRIAM-compliant data about a model's creator.

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:

 <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	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

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

def	getEmail (self)
	Returns the 'email' stored in this ModelCreator object. More...

def	getFamilyName (self)
	Returns the 'family name' stored in this ModelCreator object. More...

def	getGivenName (self)
	Returns the 'given name' stored in this ModelCreator object. More...

def	getName (self)
	Returns the 'fn' stored in this ModelCreator object when using vCard4. More...

def	getOrganisation (self)

def	getOrganization (self)
	Returns the 'organization' stored in this ModelCreator object. More...

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

def	isSetEmail (self)
	Predicate returning `True` or `False` depending on whether this ModelCreator's 'email' part is set. More...

def	isSetFamilyName (self)
	Predicate returning `True` or `False` depending on whether this ModelCreator's 'family name' part is set. More...

def	isSetGivenName (self)
	Predicate returning `True` or `False` depending on whether this ModelCreator's 'given name' part is set. More...

def	isSetName (self)
	Predicate returning `True` or `False` depending on whether this ModelCreator's 'fn' part is set (when using vCard4). More...

def	isSetOrganisation (self)

def	isSetOrganization (self)
	Predicate returning `True` or `False` depending on whether this ModelCreator's 'organization' part is set. More...

def	setEmail (self, email)
	Sets the 'email' portion of this ModelCreator object. More...

def	setFamilyName (self, familyName)
	Sets the 'family name' portion of this ModelCreator object. More...

def	setGivenName (self, givenName)
	Sets the 'given name' portion of this ModelCreator object. More...

def	setName (self, name)
	Sets the 'fn' portion of this ModelCreator object (when using vCard4). More...

def	setOrganisation (self, organization)

def	setOrganization (self, organization)
	Sets the 'organization' portion of this ModelCreator object. More...

def	unsetEmail (self)
	Unsets the 'email' portion of this ModelCreator object. More...

def	unsetFamilyName (self)
	Unsets the 'family name' portion of this ModelCreator object. More...

def	unsetGivenName (self)
	Unsets the 'given name' portion of this ModelCreator object. More...

def	unsetName (self)
	Unsets the 'fn' portion of this ModelCreator object (when using vCard4). More...

def	unsetOrganisation (self)

def	unsetOrganization (self)
	Unsets the 'organization' portion of this ModelCreator object. More...

Constructor & Destructor Documentation

def libsbml.ModelCreator.__init__	(	self,
		args
	)

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

__init__()   ModelCreator
__init__(XMLNode creator)   ModelCreator
__init__(ModelCreator orig)   ModelCreator

Each variant is described separately below.

Method variant with the following signature:

ModelCreator(XMLNode creator)

Creates a new ModelCreator from an XMLNode.

Parameters

creator the XMLNode from which to create the ModelCreator.

Method variant with the following signature:

ModelCreator()

Creates a new ModelCreator object.

Method variant with the following signature:

ModelCreator(ModelCreator orig)

Copy constructor; creates a copy of the ModelCreator.

Parameters

orig	the object to copy.

Member Function Documentation

def libsbml.ModelCreator.clone ( self )

Creates and returns a deep copy of this ModelCreator object.

clone()   ModelCreator

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

def libsbml.ModelCreator.getEmail ( self )

Returns the 'email' stored in this ModelCreator object.

getEmail()   string

Returns: email from the ModelCreator.

def libsbml.ModelCreator.getFamilyName ( self )

Returns the 'family name' stored in this ModelCreator object.

getFamilyName()   string

Returns: the 'family name' portion of the ModelCreator object.

def libsbml.ModelCreator.getGivenName ( self )

Returns the 'given name' stored in this ModelCreator object.

getGivenName()   string

Returns: the 'given name' portion of the ModelCreator object.

def libsbml.ModelCreator.getName ( self )

Returns the 'fn' stored in this ModelCreator object when using vCard4.

getName()   string

Returns: the 'fn' portion of the ModelCreator object.

def libsbml.ModelCreator.getOrganisation ( self )

getOrganisation()   string

(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 )

Returns the 'organization' stored in this ModelCreator object.

getOrganization()   string

Returns: organization from the ModelCreator.

def libsbml.ModelCreator.hasRequiredAttributes ( self )

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

hasRequiredAttributes()   bool

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 )

Predicate returning True or False depending on whether this ModelCreator's 'email' part is set.

isSetEmail()   bool

Returns: True if the email of this ModelCreator is set, False otherwise.

def libsbml.ModelCreator.isSetFamilyName ( self )

Predicate returning True or False depending on whether this ModelCreator's 'family name' part is set.

isSetFamilyName()   bool

Returns: True if the familyName of this ModelCreator is set, False otherwise.

def libsbml.ModelCreator.isSetGivenName ( self )

Predicate returning True or False depending on whether this ModelCreator's 'given name' part is set.

isSetGivenName()   bool

Returns: True if the givenName of this ModelCreator is set, False otherwise.

def libsbml.ModelCreator.isSetName ( self )

Predicate returning True or False depending on whether this ModelCreator's 'fn' part is set (when using vCard4).

isSetName()   bool

Returns: True if the fn of this ModelCreator is set, False otherwise.

def libsbml.ModelCreator.isSetOrganisation ( self )

isSetOrganisation()   bool

(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: True if the organization of this ModelCreator is set, False otherwise.

See also: isSetOrganization()

def libsbml.ModelCreator.isSetOrganization ( self )

Predicate returning True or False depending on whether this ModelCreator's 'organization' part is set.

isSetOrganization()   bool

Returns: True if the organization of this ModelCreator is set, False otherwise.

def libsbml.ModelCreator.setEmail	(	self,
		email
	)

Sets the 'email' portion of this ModelCreator object.

setEmail(string email)   int

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,
		familyName
	)

Sets the 'family name' portion of this ModelCreator object.

setFamilyName(string familyName)   int

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,
		givenName
	)

Sets the 'given name' portion of this ModelCreator object.

setGivenName(string givenName)   int

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.setName	(	self,
		name
	)

Sets the 'fn' portion of this ModelCreator object (when using vCard4).

setName(string name)   int

Parameters

name	a string representing the fn 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,
		organization
	)

setOrganisation(string organization)   int

(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,
		organization
	)

Sets the 'organization' portion of this ModelCreator object.

setOrganization(string organization)   int

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 )

Unsets the 'email' portion of this ModelCreator object.

unsetEmail()   int

Returns

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

def libsbml.ModelCreator.unsetFamilyName ( self )

Unsets the 'family name' portion of this ModelCreator object.

unsetFamilyName()   int

Returns

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

def libsbml.ModelCreator.unsetGivenName ( self )

Unsets the 'given name' portion of this ModelCreator object.

unsetGivenName()   int

Returns

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

def libsbml.ModelCreator.unsetName ( self )

Unsets the 'fn' portion of this ModelCreator object (when using vCard4).

unsetName()   int

Returns

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

def libsbml.ModelCreator.unsetOrganisation ( self )

unsetOrganisation()   int

(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 )

Unsets the 'organization' portion of this ModelCreator object.

unsetOrganization()   int

Returns

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

Detailed Description

The different parts of a model creator definition

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation