libSBML C# API  libSBML 5.13.0 C# API
libsbmlcs.ModelCreator Class Reference
Inheritance diagram for libsbmlcs.ModelCreator:
[legend]

Detailed Description

{core}

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

ModelCreator clone ()
 Creates and returns a deep copy of this ModelCreator object. More...
 
virtual void Dispose ()
 
override bool Equals (Object sb)
 
string getEmail ()
 Returns the 'email' stored in this ModelCreator object. More...
 
string getFamilyName ()
 Returns the 'family name' stored in this ModelCreator object. More...
 
string getGivenName ()
 Returns the 'given name' stored in this ModelCreator object. More...
 
override int GetHashCode ()
 
string getOrganisation ()
 (Alternate spelling) Returns the 'organization' stored in this ModelCreator object. More...
 
string getOrganization ()
 Returns the 'organization' stored in this ModelCreator object. More...
 
bool hasBeenModified ()
 
bool hasRequiredAttributes ()
 Predicate returning true if all the required elements for this ModelCreator object have been set. More...
 
bool isSetEmail ()
 Predicate returning true or false depending on whether this ModelCreator's 'email' part is set. More...
 
bool isSetFamilyName ()
 Predicate returning true or false depending on whether this ModelCreator's 'family name' part is set. More...
 
bool isSetGivenName ()
 Predicate returning true or false depending on whether this ModelCreator's 'given name' part is set. More...
 
bool isSetOrganisation ()
 (Alternate spelling) Predicate returning true or false depending on whether this ModelCreator's 'organization' part is set. More...
 
bool isSetOrganization ()
 Predicate returning true or false depending on whether this ModelCreator's 'organization' part is set. More...
 
 ModelCreator ()
 Creates a new ModelCreator object. More...
 
 ModelCreator (XMLNode creator)
 Creates a new ModelCreator from an XMLNode. More...
 
 ModelCreator (ModelCreator orig)
 Copy constructor; creates a copy of the ModelCreator. More...
 
void resetModifiedFlags ()
 
int setEmail (string email)
 Sets the 'email' portion of this ModelCreator object. More...
 
int setFamilyName (string familyName)
 Sets the 'family name' portion of this ModelCreator object. More...
 
int setGivenName (string givenName)
 Sets the 'given name' portion of this ModelCreator object. More...
 
int setOrganisation (string organization)
 (Alternate spelling) Sets the 'organization' portion of this ModelCreator object. More...
 
int setOrganization (string organization)
 Sets the 'organization' portion of this ModelCreator object. More...
 
int unsetEmail ()
 Unsets the 'email' portion of this ModelCreator object. More...
 
int unsetFamilyName ()
 Unsets the 'family name' portion of this ModelCreator object. More...
 
int unsetGivenName ()
 Unsets the 'given name' portion of this ModelCreator object. More...
 
int unsetOrganisation ()
 (Alternate spelling) Unsets the 'organization' portion of this ModelCreator object. More...
 
int unsetOrganization ()
 Unsets the 'organization' portion of this ModelCreator object. More...
 

Static Public Member Functions

static bool operator!= (ModelCreator lhs, ModelCreator rhs)
 
static bool operator== (ModelCreator lhs, ModelCreator rhs)
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

§ ModelCreator() [1/3]

libsbmlcs.ModelCreator.ModelCreator ( )

Creates a new ModelCreator object.

§ ModelCreator() [2/3]

libsbmlcs.ModelCreator.ModelCreator ( XMLNode  creator)

Creates a new ModelCreator from an XMLNode.

Parameters
creatorthe XMLNode from which to create the ModelCreator.

§ ModelCreator() [3/3]

libsbmlcs.ModelCreator.ModelCreator ( ModelCreator  orig)

Copy constructor; creates a copy of the ModelCreator.

Parameters
origthe object to copy.

Member Function Documentation

§ clone()

ModelCreator libsbmlcs.ModelCreator.clone ( )

Creates and returns a deep copy of this ModelCreator object.

Returns
the (deep) copy of this ModelCreator object.

§ Dispose()

virtual void libsbmlcs.ModelCreator.Dispose ( )
virtual

§ Equals()

override bool libsbmlcs.ModelCreator.Equals ( Object  sb)

§ getEmail()

string libsbmlcs.ModelCreator.getEmail ( )

Returns the 'email' stored in this ModelCreator object.

Returns
email from the ModelCreator.

§ getFamilyName()

string libsbmlcs.ModelCreator.getFamilyName ( )

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

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

§ getGivenName()

string libsbmlcs.ModelCreator.getGivenName ( )

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

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

§ GetHashCode()

override int libsbmlcs.ModelCreator.GetHashCode ( )

§ getOrganisation()

string libsbmlcs.ModelCreator.getOrganisation ( )

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

§ getOrganization()

string libsbmlcs.ModelCreator.getOrganization ( )

Returns the 'organization' stored in this ModelCreator object.

Returns
organization from the ModelCreator.

§ hasBeenModified()

bool libsbmlcs.ModelCreator.hasBeenModified ( )

§ hasRequiredAttributes()

bool libsbmlcs.ModelCreator.hasRequiredAttributes ( )

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'.

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

§ isSetEmail()

bool libsbmlcs.ModelCreator.isSetEmail ( )

Predicate returning true or false depending on whether this ModelCreator's 'email' part is set.

Returns
true if the email of this ModelCreator is set, false otherwise.

§ isSetFamilyName()

bool libsbmlcs.ModelCreator.isSetFamilyName ( )

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

Returns
true if the familyName of this ModelCreator is set, false otherwise.

§ isSetGivenName()

bool libsbmlcs.ModelCreator.isSetGivenName ( )

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

Returns
true if the givenName of this ModelCreator is set, false otherwise.

§ isSetOrganisation()

bool libsbmlcs.ModelCreator.isSetOrganisation ( )

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

§ isSetOrganization()

bool libsbmlcs.ModelCreator.isSetOrganization ( )

Predicate returning true or false depending on whether this ModelCreator's 'organization' part is set.

Returns
true if the organization of this ModelCreator is set, false otherwise.

§ operator!=()

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

§ operator==()

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

§ resetModifiedFlags()

void libsbmlcs.ModelCreator.resetModifiedFlags ( )

§ setEmail()

int libsbmlcs.ModelCreator.setEmail ( string  email)

Sets the 'email' portion of this ModelCreator object.

Parameters
emaila string representing the email of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

§ setFamilyName()

int libsbmlcs.ModelCreator.setFamilyName ( string  familyName)

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

Parameters
familyNamea string representing the familyName of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

§ setGivenName()

int libsbmlcs.ModelCreator.setGivenName ( string  givenName)

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

Parameters
givenNamea string representing the givenName of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

§ setOrganisation()

int libsbmlcs.ModelCreator.setOrganisation ( string  organization)

(Alternate spelling) Sets the 'organization' portion of this ModelCreator object.

Parameters
organizationa 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(string organization)

§ setOrganization()

int libsbmlcs.ModelCreator.setOrganization ( string  organization)

Sets the 'organization' portion of this ModelCreator object.

Parameters
organizationa string representing the organization of the ModelCreator.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

§ unsetEmail()

int libsbmlcs.ModelCreator.unsetEmail ( )

Unsets the 'email' portion of this ModelCreator object.

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

§ unsetFamilyName()

int libsbmlcs.ModelCreator.unsetFamilyName ( )

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

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

§ unsetGivenName()

int libsbmlcs.ModelCreator.unsetGivenName ( )

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

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

§ unsetOrganisation()

int libsbmlcs.ModelCreator.unsetOrganisation ( )

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

§ unsetOrganization()

int libsbmlcs.ModelCreator.unsetOrganization ( )

Unsets the 'organization' portion of this ModelCreator object.

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

Member Data Documentation

§ swigCMemOwn

bool libsbmlcs.ModelCreator.swigCMemOwn
protected