ModelCreator Class Reference

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.

Examples:

addModelHistory.cpp.

Public Member Functions
ModelCreator *	clone () const
	Creates and returns a deep copy of this ModelCreator object. More...
const std::string &	getEmail () const
	Returns the "email" stored in this ModelCreator object. More...
const std::string &	getFamilyName () const
	Returns the "family name" stored in this ModelCreator object. More...
const std::string &	getGivenName () const
	Returns the "given name" stored in this ModelCreator object. More...
const std::string &	getName () const
	Returns the "fn" stored in this ModelCreator object when using vCard4. More...
const std::string &	getOrganisation () const
	(Alternate spelling) Returns the "organization" stored in this ModelCreator object. More...
const std::string &	getOrganization () const
	Returns the "organization" stored in this ModelCreator object. More...
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	isSetName ()
	Predicate returning true or false depending on whether this ModelCreator's "fn" part is set (when using vCard4). 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 (const XMLNode creator)
	Creates a new ModelCreator from an XMLNode. More...
	ModelCreator (const ModelCreator &orig)
	Copy constructor; creates a copy of the ModelCreator. More...
ModelCreator &	operator= (const ModelCreator &rhs)
	Assignment operator. More...
int	setEmail (const std::string &email)
	Sets the "email" portion of this ModelCreator object. More...
int	setFamilyName (const std::string &familyName)
	Sets the "family name" portion of this ModelCreator object. More...
int	setGivenName (const std::string &givenName)
	Sets the "given name" portion of this ModelCreator object. More...
int	setName (const std::string &name)
	Sets the "fn" portion of this ModelCreator object (when using vCard4). More...
int	setOrganisation (const std::string &organization)
	(Alternate spelling) Sets the "organization" portion of this ModelCreator object. More...
int	setOrganization (const std::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	unsetName ()
	Unsets the "fn" portion of this ModelCreator object (when using vCard4). 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...
	~ModelCreator ()
	Destroys the ModelCreator. More...

Constructor & Destructor Documentation

ModelCreator::ModelCreator

(

)

Creates a new ModelCreator object.

ModelCreator::ModelCreator

(

const XMLNode

creator

)

Creates a new ModelCreator from an XMLNode.

Parameters

creator

the XMLNode from which to create the ModelCreator.

ModelCreator::~ModelCreator

(

)

Destroys the ModelCreator.

ModelCreator::ModelCreator

(

const ModelCreator &

orig

)

Copy constructor; creates a copy of the ModelCreator.

Parameters

orig	the object to copy.

Member Function Documentation

ModelCreator * ModelCreator::clone

(

)

const

Creates and returns a deep copy of this ModelCreator object.

Returns

the (deep) copy of this ModelCreator object.

const std::string& ModelCreator::getEmail ( ) const

inline

Returns the "email" stored in this ModelCreator object.

Returns

email from the ModelCreator.

const std::string& ModelCreator::getFamilyName ( ) const

inline

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

Returns

the "family name" portion of the ModelCreator object.

const std::string& ModelCreator::getGivenName ( ) const

inline

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

Returns

the "given name" portion of the ModelCreator object.

const std::string& ModelCreator::getName ( ) const

inline

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

Returns

the "fn" portion of the ModelCreator object.

const std::string& ModelCreator::getOrganisation ( ) const

inline

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

const std::string& ModelCreator::getOrganization ( ) const

inline

Returns the "organization" stored in this ModelCreator object.

Returns

organization from the ModelCreator.

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

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

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

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

bool ModelCreator::isSetName

(

)

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

Returns

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

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

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

ModelCreator & ModelCreator::operator=

(

const ModelCreator &

rhs

)

Assignment operator.

Parameters

rhs	the object whose values are used as the basis of the assignment.

int ModelCreator::setEmail

(

const std::string &

email

)

Sets the "email" portion of this ModelCreator object.

Parameters

email

a string representing the email of the ModelCreator.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Examples:

addModelHistory.cpp.

int ModelCreator::setFamilyName

(

const std::string &

familyName

)

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

Parameters

familyName

a string representing the familyName of the ModelCreator.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Examples:

addModelHistory.cpp.

int ModelCreator::setGivenName

(

const std::string &

givenName

)

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

Parameters

givenName

a string representing the givenName of the ModelCreator.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Examples:

addModelHistory.cpp.

int ModelCreator::setName

(

const std::string &

name

)

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

Parameters

name	a string representing the fn of the ModelCreator.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

int ModelCreator::setOrganisation

(

const std::string &

organization

)

(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(const std::string& organization).

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

See also

setOrganization(std::string organization)

int ModelCreator::setOrganization

(

const std::string &

organization

)

Sets the "organization" portion of this ModelCreator object.

Parameters

organization

a string representing the organization of the ModelCreator.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

Examples:

addModelHistory.cpp.

int ModelCreator::unsetEmail

(

)

Unsets the "email" portion of this ModelCreator object.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED

int ModelCreator::unsetFamilyName

(

)

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

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED

int ModelCreator::unsetGivenName

(

)

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

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED

int ModelCreator::unsetName

(

)

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

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED

int 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 value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED

See also

unsetOrganization()

int ModelCreator::unsetOrganization

(

)

Unsets the "organization" portion of this ModelCreator object.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED