#include <core/Unit.hpp>

Public Member Functions
	Unit (const UnitClass_t aClass, const UnitID_t anID, const PcsOrd_t aPcsOrder)

	~Unit ()

PcsOrd_t	getProcessOrder () const

UnitID_t	getID () const

UnitClass_t	getClass () const

bool	addToUnit (Unit *aUnit)

bool	addFromUnit (Unit *aUnit)

bool	addParentUnit (Unit *aUnit)

bool	addChildUnit (Unit *aUnit)

UnitsPtrList_t *	getToUnits (const UnitClass_t aClass)

const UnitsPtrList_t *	getToUnits (const UnitClass_t aClass) const

UnitsPtrList_t *	getFromUnits (const UnitClass_t aClass)

const UnitsPtrList_t *	getFromUnits (const UnitClass_t aClass) const

UnitsPtrList_t *	getParentUnits (const UnitClass_t aClass)

const UnitsPtrList_t *	getParentUnits (const UnitClass_t aClass) const

UnitsPtrList_t *	getChildrenUnits (const UnitClass_t aClass)

const UnitsPtrList_t *	getChildrenUnits (const UnitClass_t aClass) const

Attributes *	getAttributes ()

const Attributes *	getAttributes () const

Variables *	getVariables ()

const Variables *	getVariables () const

EventsCollection *	getEvents ()

const EventsCollection *	getEvents () const

void	streamContents (std::ostream &OStream)

void	setProcessOrder (unsigned int PcsOrder)

Detailed Description

Class defining a spatial unit

example of use:

openfluid::core::Unit aUnit;
openfluid::core::Unit* aUnitPtr;
openfluid::core::UnitClass_t aUnitClass;
openfluid::core::UnitID_t aUnitID;
openfluid::core::UnitsPtrList_t* aUnitListPtr;
// *** get unit ID ***
aUnitID = aUnit.getID();
// or (pointed unit)
aUnitID = aUnitPtr->getID();
// *** get unit class ***
aUnitClass = aUnit.getClass();
// or (pointed unit)
aUnitClass = aUnitPtr->getClass();
// *** get connected units (to and from) ***
aUnitListPtr = aUnit.getToUnits("foo");
// or
aUnitListPtr = aUnit.getFromUnits("bar");

Constructor & Destructor Documentation

openfluid::core::Unit::Unit	(	const UnitClass_t	aClass,
		const UnitID_t	anID,
		const PcsOrd_t	aPcsOrder
	)

openfluid::core::Unit::~Unit ( )

Member Function Documentation

bool openfluid::core::Unit::addChildUnit ( Unit * aUnit )

bool openfluid::core::Unit::addFromUnit ( Unit * aUnit )

bool openfluid::core::Unit::addParentUnit ( Unit * aUnit )

bool openfluid::core::Unit::addToUnit ( Unit * aUnit )

Attributes* openfluid::core::Unit::getAttributes ( )

inline

const Attributes* openfluid::core::Unit::getAttributes ( ) const

inline

UnitsPtrList_t* openfluid::core::Unit::getChildrenUnits ( const UnitClass_t aClass )

Returns a list of children units of the requested class. Returns NULL if this unit has no child

Parameters

[in] aClass the requested class

const UnitsPtrList_t* openfluid::core::Unit::getChildrenUnits ( const UnitClass_t aClass ) const

UnitClass_t openfluid::core::Unit::getClass ( ) const

inline

Returns the class of the unit

EventsCollection* openfluid::core::Unit::getEvents ( )

inline

const EventsCollection* openfluid::core::Unit::getEvents ( ) const

inline

UnitsPtrList_t* openfluid::core::Unit::getFromUnits ( const UnitClass_t aClass )

Returns a list of units, of the requested class, connected from this unit. Returns NULL if no units of the requested class are connected from this unit.

Parameters

[in] aClass the requested class

const UnitsPtrList_t* openfluid::core::Unit::getFromUnits ( const UnitClass_t aClass ) const

UnitID_t openfluid::core::Unit::getID ( ) const

inline

Returns the ID of the unit

UnitsPtrList_t* openfluid::core::Unit::getParentUnits ( const UnitClass_t aClass )

Returns a list of parent units of the requested class. Returns NULL if this unit has no parent

Parameters

[in] aClass the requested class

const UnitsPtrList_t* openfluid::core::Unit::getParentUnits ( const UnitClass_t aClass ) const

PcsOrd_t openfluid::core::Unit::getProcessOrder ( ) const

inline

Returns the process order of the unit

UnitsPtrList_t* openfluid::core::Unit::getToUnits ( const UnitClass_t aClass )

Returns a list of units, of the requested class, connected to this unit. Returns NULL if no units of the requested class are connected to this unit.

Parameters

[in] aClass the requested class

const UnitsPtrList_t* openfluid::core::Unit::getToUnits ( const UnitClass_t aClass ) const

Variables* openfluid::core::Unit::getVariables ( )

inline

const Variables* openfluid::core::Unit::getVariables ( ) const

inline

void openfluid::core::Unit::setProcessOrder ( unsigned int PcsOrder )

inline

void openfluid::core::Unit::streamContents ( std::ostream & OStream )

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

core/Unit.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation