CReference Class Reference

#include <CReference.h>

Inheritance diagram for CReference:

List of all members.

Public Member Functions
	CReference (const std::string &objectName, const CCopasiContainer *pParent=NULL)
	CReference (const CRDFTriplet &triplet, const std::string &objectName="", const CCopasiContainer *pParent=NULL)
	CReference (const CReference &src, const CCopasiContainer *pParent=NULL)
	~CReference ()
const CRDFTriplet &	getTriplet () const
virtual const std::string &	getKey () const
std::string	getResource () const
const std::string &	getId () const
const std::string &	getDescription () const
std::string	getURI () const
void	setResource (const std::string &resource)
void	setId (const std::string &id)
void	setDescription (const std::string &description)
void	clearInvalidEntries ()

---

Detailed Description

CReferences: Stores publication details such as PubMed Id and DOI.

---

Constructor & Destructor Documentation

CReference::CReference	(	const std::string &	objectName,
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

const	std::string & objectName
const	CCopasiContainer * pParent (default: NULL)

CReference::CReference	(	const CRDFTriplet &	triplet,
		const std::string &	objectName = "",
		const CCopasiContainer *	pParent = NULL
	)

Specific constructor

Parameters:

const	CRDFTriplet & triplet
const	std::string & objectName (default: "")
const	CCopasiContainer * pParent (default: NULL)

CReference::CReference	(	const CReference &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor

Parameters:

const CReference &	src
const	CCopasiContainer * pParent (default: NULL)

CReference::~CReference

(

)

Destructor

---

Member Function Documentation

void CReference::clearInvalidEntries

(

)

Remove invalid combinations of resource and id

const std::string & CReference::getDescription

(

)

const

Retrieve the description for the reference.

Returns:

std::string description

const std::string & CReference::getId

(

)

const

Retrieve the id of the reference in the MIRIAM resource.

Returns:

const std::string & id

const std::string & CReference::getKey

(

)

const [virtual]

Retrieve the key for the object

Returns:

const std::string & key

Reimplemented from CCopasiObject.

std::string CReference::getResource

(

)

const

Retrieve the MIRIAM resource for the reference.

Returns:

std::string resource

const CRDFTriplet & CReference::getTriplet

(

)

const

Retrieve the RDF triplet holding the information for this reference.

Returns:

const CRDFTriplet & triplet

std::string CReference::getURI

(

)

const

Retrieve the URI (comprised of resource an id) specifying this reference.

Returns:

std::string uri

void CReference::setDescription

(

const std::string &

description

)

Set the description for the reference.

Parameters:

std::string

description

void CReference::setId

(

const std::string &

id

)

Set the id of the reference in the MIRIAM resource.

Parameters:

const

std::string & id

void CReference::setResource

(

const std::string &

resource

)

Set the MIRIAM resource for the reference

Parameters:

const

std::string & resource

---

The documentation for this class was generated from the following files:

• copasi/MIRIAM/CReference.h
• copasi/MIRIAM/CReference.cpp