CMIRIAMResources Class Reference

#include <CMIRIAMResource.h>

Inheritance diagram for CMIRIAMResources:

List of all members.

Public Member Functions
	CMIRIAMResources (const std::string &name="MIRIAM Resources", const CCopasiContainer *pParent=NULL)
	CMIRIAMResources (const CMIRIAMResources &src, const CCopasiContainer *pParent=NULL)
	CMIRIAMResources (const CCopasiParameterGroup &group, const CCopasiContainer *pParent=NULL)
virtual	~CMIRIAMResources ()
virtual bool	elevateChildren ()
void	addMIRIAMResource (CMIRIAMResource *pMIRIAMResource)
const CMIRIAMResources &	getMIRIAMResources () const
const unsigned C_INT32 &	getMIRIAMLastUpdateDate () const
const unsigned C_INT32 &	getMIRIAMUpdateFrequency () const
void	setMIRIAMUpdateFrequency (const unsigned C_INT32 updateFrequency)
bool	updateMIRIAMResources (CProcessReport *pProcessReport)
bool	autoUpdateMIRIAMResources (CProcessReport *pProcessReport)
const CMIRIAMResource &	getMIRIAMResource (const unsigned C_INT32 index) const
unsigned C_INT32	getMIRIAMResourceIndex (const std::string &URI) const
unsigned C_INT32	getResourceIndexFromDisplayName (const std::string &displayName) const
const CCopasiParameterGroup &	getResourceList () const
void	initializeParameter ()

---

Constructor & Destructor Documentation

CMIRIAMResources::CMIRIAMResources	(	const std::string &	name = "MIRIAM Resources",
		const CCopasiContainer *	pParent = NULL
	)

Default constructor

Parameters:

const	std::string & name (default: MIRIAM Resources)
const	CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

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

CMIRIAMResources::CMIRIAMResources	(	const CCopasiParameterGroup &	group,
		const CCopasiContainer *	pParent = NULL
	)

Specific constructor

Parameters:

const	CCopasiParameterGroup & group
const	CCopasiContainer * pParent (default: NULL)

CMIRIAMResources::~CMIRIAMResources

(

)

[virtual]

Destructor

---

Member Function Documentation

void CMIRIAMResources::addMIRIAMResource

(

CMIRIAMResource *

pMIRIAMResource

)

Add a MIRIAM Resource to the list of MIRIAM Resources

Parameters:

CMIRIAMResource

* pMIRIAMResource

bool CMIRIAMResources::autoUpdateMIRIAMResources

(

CProcessReport *

pProcessReport

)

Automatically update the resources when the last update is older than the current date minus the update interval.

Parameters:

CProcessReport

* pProcessReport

Returns:

bool success

bool CMIRIAMResources::elevateChildren

(

)

[virtual]

This methods must be called to elevate subgroups to derived objects. The default implementation does nothing.

Returns:

bool success

Reimplemented from CCopasiParameterGroup.

const unsigned C_INT32 & CMIRIAMResources::getMIRIAMLastUpdateDate

(

)

const

Retrieve the day the resources where last updated

Returns:

const unsigned C_INT32 & lastUpdateDay

const CMIRIAMResource & CMIRIAMResources::getMIRIAMResource

(

const unsigned C_INT32

index

)

const

Retrieve the indexed resource

Parameters:

const

unsigned C_INT32 index

Returns:

const CMIRIAMResource & resource

unsigned C_INT32 CMIRIAMResources::getMIRIAMResourceIndex

(

const std::string &

URI

)

const

Retrieve the index of the resource with the given URI

Parameters:

const

std::string & URI

Returns:

unsigned C_INT32 index

const CMIRIAMResources & CMIRIAMResources::getMIRIAMResources

(

)

const

Retrieve the list of MIRIAM Resources

Returns:

CMIRIAMResources & MIRIAMResources

const unsigned C_INT32 & CMIRIAMResources::getMIRIAMUpdateFrequency

(

)

const

Retrieve the of interval between updates

Returns:

const unsigned C_INT32 & updateFrequency

unsigned C_INT32 CMIRIAMResources::getResourceIndexFromDisplayName

(

const std::string &

displayName

)

const

Retrieve the index of the resource with the given display name

Parameters:

const

std::string & displayName

Returns:

unsigned C_INT32 index

const CCopasiParameterGroup & CMIRIAMResources::getResourceList

(

)

const

Retrieve the list of MIRIAM resource as a CCopasiParameterGroup

Returns:

const CCopasiParameterGroup & resourceList

void CMIRIAMResources::initializeParameter

(

)

Allocates all group parameters and assures that they are properly initialized.

void CMIRIAMResources::setMIRIAMUpdateFrequency

(

const unsigned C_INT32

updateFrequency

)

Set the of interval between updates

Parameters:

const

unsigned C_INT32 & updateFrequency

bool CMIRIAMResources::updateMIRIAMResources

(

CProcessReport *

pProcessReport

)

Update the MIRIAM resources

Parameters:

CProcessReport

* pProcessReport

Returns:

bool success

---

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

• copasi/MIRIAM/CMIRIAMResource.h
• copasi/MIRIAM/CMIRIAMResource.cpp