openfluid::core::SpatialUnit Class Reference

#include <core/SpatialUnit.hpp>

Public Member Functions
	SpatialUnit (const UnitsClass_t &aClass, const UnitID_t anID, const PcsOrd_t aPcsOrder)
	~SpatialUnit ()
PcsOrd_t	getProcessOrder () const
UnitID_t	getID () const
UnitsClass_t	getClass () const
bool	addToUnit (SpatialUnit *aUnit)
bool	addFromUnit (SpatialUnit *aUnit)
bool	addParentUnit (SpatialUnit *aUnit)
bool	addChildUnit (SpatialUnit *aUnit)
UnitsPtrList_t *	toSpatialUnits (const UnitsClass_t &aClass)
const UnitsPtrList_t *	toSpatialUnits (const UnitsClass_t &aClass) const
UnitsPtrList_t *	getToUnits (const UnitsClass_t &aClass) OPENFLUID_DEPRECATED
const UnitsPtrList_t *	getToUnits (const UnitsClass_t &aClass) const OPENFLUID_DEPRECATED
UnitsPtrList_t *	fromSpatialUnits (const UnitsClass_t &aClass)
const UnitsPtrList_t *	fromSpatialUnits (const UnitsClass_t &aClass) const
UnitsPtrList_t *	getFromUnits (const UnitsClass_t &aClass) OPENFLUID_DEPRECATED
const UnitsPtrList_t *	getFromUnits (const UnitsClass_t &aClass) const
UnitsPtrList_t *	parentSpatialUnits (const UnitsClass_t &aClass)
const UnitsPtrList_t *	parentSpatialUnits (const UnitsClass_t &aClass) const
UnitsPtrList_t *	getParentUnits (const UnitsClass_t &aClass) OPENFLUID_DEPRECATED
const UnitsPtrList_t *	getParentUnits (const UnitsClass_t &aClass) const OPENFLUID_DEPRECATED
UnitsPtrList_t *	childSpatialUnits (const UnitsClass_t &aClass)
const UnitsPtrList_t *	childSpatialUnits (const UnitsClass_t &aClass) const
UnitsPtrList_t *	getChildrenUnits (const UnitsClass_t &aClass) OPENFLUID_DEPRECATED
const UnitsPtrList_t *	getChildrenUnits (const UnitsClass_t &aClass) const OPENFLUID_DEPRECATED
Attributes *	attributes ()
const Attributes *	attributes () const
Variables *	variables ()
const Variables *	variables () const
EventsCollection *	events ()
const EventsCollection *	events () const
void	streamContents (std::ostream &OStream)
void	setProcessOrder (unsigned int PcsOrder)

Detailed Description

Class defining a spatial unit

example of use:

openfluid::core::SpatialUnit aUnit;
openfluid::core::SpatialUnit* aUnitPtr;
openfluid::core::UnitsClass_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.toSpatialUnits("foo");
// or
aUnitListPtr = aUnit.fromSpatialUnits("bar");

Constructor & Destructor Documentation

openfluid::core::SpatialUnit::SpatialUnit	(	const UnitsClass_t &	aClass,
		const UnitID_t	anID,
		const PcsOrd_t	aPcsOrder
	)

openfluid::core::SpatialUnit::~SpatialUnit

(

)

Member Function Documentation

bool openfluid::core::SpatialUnit::addChildUnit

(

SpatialUnit *

aUnit

)

bool openfluid::core::SpatialUnit::addFromUnit

(

SpatialUnit *

aUnit

)

bool openfluid::core::SpatialUnit::addParentUnit

(

SpatialUnit *

aUnit

)

bool openfluid::core::SpatialUnit::addToUnit

(

SpatialUnit *

aUnit

)

Attributes* openfluid::core::SpatialUnit::attributes ( )

inline

const Attributes* openfluid::core::SpatialUnit::attributes ( ) const

inline

UnitsPtrList_t* openfluid::core::SpatialUnit::childSpatialUnits

(

const UnitsClass_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::SpatialUnit::childSpatialUnits

(

const UnitsClass_t &

aClass

)

const

EventsCollection* openfluid::core::SpatialUnit::events ( )

inline

const EventsCollection* openfluid::core::SpatialUnit::events ( ) const

inline

UnitsPtrList_t* openfluid::core::SpatialUnit::fromSpatialUnits

(

const UnitsClass_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::SpatialUnit::fromSpatialUnits

(

const UnitsClass_t &

aClass

)

const

UnitsPtrList_t* openfluid::core::SpatialUnit::getChildrenUnits ( const UnitsClass_t &  aClass )

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::childSpatialUnits(const UnitsClass_t&) instead

const UnitsPtrList_t* openfluid::core::SpatialUnit::getChildrenUnits ( const UnitsClass_t &  aClass ) const

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::childSpatialUnits(const UnitsClass_t&) const instead

UnitsClass_t openfluid::core::SpatialUnit::getClass ( ) const

inline

Returns the class of the unit

UnitsPtrList_t* openfluid::core::SpatialUnit::getFromUnits ( const UnitsClass_t &  aClass )

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::fromSpatialUnits(const UnitsClass_t&) instead

const UnitsPtrList_t* openfluid::core::SpatialUnit::getFromUnits ( const UnitsClass_t &  aClass ) const

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::fromSpatialUnits(const UnitsClass_t&) const instead

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

inline

Returns the ID of the unit

UnitsPtrList_t* openfluid::core::SpatialUnit::getParentUnits ( const UnitsClass_t &  aClass )

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::parentSpatialUnits(const UnitsClass_t&) instead

const UnitsPtrList_t* openfluid::core::SpatialUnit::getParentUnits ( const UnitsClass_t &  aClass ) const

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::parentSpatialUnits(const UnitsClass_t&) const instead

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

inline

Returns the process order of the unit

UnitsPtrList_t* openfluid::core::SpatialUnit::getToUnits ( const UnitsClass_t &  aClass )

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::toSpatialUnits(const UnitsClass_t&) instead

const UnitsPtrList_t* openfluid::core::SpatialUnit::getToUnits ( const UnitsClass_t &  aClass ) const

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::SpatialUnit::toSpatialUnits(const UnitsClass_t&) const instead

UnitsPtrList_t* openfluid::core::SpatialUnit::parentSpatialUnits

(

const UnitsClass_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::SpatialUnit::parentSpatialUnits

(

const UnitsClass_t &

aClass

)

const

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

inline

void openfluid::core::SpatialUnit::streamContents

(

std::ostream &

OStream

)

UnitsPtrList_t* openfluid::core::SpatialUnit::toSpatialUnits

(

const UnitsClass_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::SpatialUnit::toSpatialUnits

(

const UnitsClass_t &

aClass

)

const

Variables* openfluid::core::SpatialUnit::variables ( )

inline

const Variables* openfluid::core::SpatialUnit::variables ( ) const

inline

---

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

• core/SpatialUnit.hpp