CDimension Class Reference

#include <CDimension.h>

List of all members.

Public Member Functions
	CDimension ()
void	setUnknown ()
bool	isUnknown () const
void	setContradiction ()
bool	isContradiction () const
void	setDimension (const C_FLOAT64 &d1, const C_FLOAT64 &d2, const C_FLOAT64 &d3, const C_FLOAT64 &d4, const C_FLOAT64 &d5)
std::string	getDisplayString (const CCopasiDataModel *pDataModel) const
std::string	getDebugString () const
bool	operator== (const CDimension &rhs) const
CDimension	operator+ (const CDimension &rhs) const
CDimension	operator- (const CDimension &rhs) const
CDimension	operator* (const C_FLOAT64 &rhs) const
CDimension	compare (const CDimension &rhs) const
void	fixDimensionless (bool d1, bool d2, bool d3, bool d4, bool d5)
std::string	print (const CCopasiDataModel *pDataModel) const

---

Detailed Description

CDimension class. The class describes the dimension of a value, usually a CFunctionParameter.

The dimension is given as a quintuple of real numbers: (amount of substance, volume, time, area, length). It can also be "unknown" or "contradiction". The actual unit can be constructed from the dimension and the 5 basic units from the CModel class (which is done in the getDisplayString() method).

---

Constructor & Destructor Documentation

CDimension::CDimension

(

)

---

Member Function Documentation

CDimension CDimension::compare

(

const CDimension &

rhs

)

const

void CDimension::fixDimensionless	(	bool	d1,
		bool	d2,
		bool	d3,
		bool	d4,
		bool	d5
	)

If one of the base units is dimensionless, the corresponding exponent is adjusted to be 0.0. d1,d2,d3, d4, d5 indicate whether the base units are dimensionless

std::string CDimension::getDebugString

(

)

const

std::string CDimension::getDisplayString

(

const CCopasiDataModel *

pDataModel

)

const

bool CDimension::isContradiction

(

)

const

bool CDimension::isUnknown

(

)

const

CDimension CDimension::operator*

(

const C_FLOAT64 &

rhs

)

const

CDimension CDimension::operator+

(

const CDimension &

rhs

)

const

CDimension CDimension::operator-

(

const CDimension &

rhs

)

const

bool CDimension::operator==

(

const CDimension &

rhs

)

const

std::string CDimension::print

(

const CCopasiDataModel *

pDataModel

)

const

insert operator

Disabled becuase the in order to generate output, the dimensions instance needs the datamodel. std::ostream & operator<<(std::ostream &os, const CDimension & d) { if (d.mUnknown) os << "Dim: unknown"; else if (d.mContradiction) os << "Dim: conctradiction"; else os << "Dim: (" << d.mD1 << ", " << d.mD2 << ", " << d.mD3 << ") " << d.getDisplayString();

return os; }

void CDimension::setContradiction

(

)

void CDimension::setDimension	(	const C_FLOAT64 &	d1,
		const C_FLOAT64 &	d2,
		const C_FLOAT64 &	d3,
		const C_FLOAT64 &	d4,
		const C_FLOAT64 &	d5
	)

void CDimension::setUnknown

(

)

---

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

• copasi/utilities/CDimension.h
• copasi/utilities/CDimension.cpp