CUnitInformation Class Reference

#include <CUnit.h>

Inheritance diagram for CUnitInformation:

List of all members.

Public Types
enum	INFO {   UNKNOWN = 0, DEFAULT, GLOBAL, PROVIDED,   DERIVED }
	this enum encodes the status of a units information More...
Public Member Functions
	CUnitInformation (unsigned int sbmlLevel, unsigned int sbmlVersion)
	Default constructor.
	CUnitInformation (unsigned int sbmlLevel, unsigned int sbmlVersion, INFO info, bool conflict=false)
	CUnitInformation (const CUnit &u, INFO info, bool conflict=false)
	CUnitInformation (const UnitDefinition *ud, INFO info, bool conflict=false)
void	setInfo (INFO info)
	set the status information
INFO	getInfo () const
	get the status information
void	setConflict (bool c)
	set the conflict flag
bool	isConflict () const
	retrieve the conflict flag
virtual std::string	getDisplayString () const
Static Public Member Functions
static bool	isEqual (const CUnitInformation &unit1, const CUnitInformation &unit2)

---

Detailed Description

This class contains one unit definition plus some meta information, e.g. whether the unit was provided or calculated, if it is unknown or if there is a conflict.

---

Member Enumeration Documentation

enum CUnitInformation::INFO

this enum encodes the status of a units information

Enumerator:

UNKNOWN	the units is unknown
DEFAULT	the units is determined from the sbml defaults
GLOBAL	the units is determined from the model-wide definitions
PROVIDED	the units if provided for a specific object explicitly
DERIVED	the units was determined by reasoning

---

Constructor & Destructor Documentation

CUnitInformation::CUnitInformation	(	unsigned int	sbmlLevel,
		unsigned int	sbmlVersion
	)

Default constructor.

CUnitInformation::CUnitInformation	(	unsigned int	sbmlLevel,
		unsigned int	sbmlVersion,
		INFO	info,
		bool	conflict = false
	)

CUnitInformation::CUnitInformation	(	const CUnit &	u,
		INFO	info,
		bool	conflict = false
	)

CUnitInformation::CUnitInformation	(	const UnitDefinition *	ud,
		INFO	info,
		bool	conflict = false
	)

---

Member Function Documentation

std::string CUnitInformation::getDisplayString

(

)

const [virtual]

Reimplemented from CUnit.

INFO CUnitInformation::getInfo

(

)

const [inline]

get the status information

bool CUnitInformation::isConflict

(

)

const [inline]

retrieve the conflict flag

bool CUnitInformation::isEqual	(	const CUnitInformation &	unit1,
		const CUnitInformation &	unit2
	)		[static]

void CUnitInformation::setConflict

(

bool

c

)

[inline]

set the conflict flag

void CUnitInformation::setInfo

(

INFO

info

)

[inline]

set the status information

---

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

• copasi/sbmlunit/CUnit.h
• copasi/sbmlunit/CUnit.cpp