openfluid::core::Unit Class Reference

List of all members.

Public Member Functions
unsigned int	getProcessOrder () const
UnitID_t	getID () const
UnitClass_t	getClass () const
UnitsPtrList_t *	getToUnits (const UnitClass_t aClass)
UnitsPtrList_t *	getFromUnits (const UnitClass_t aClass)
UnitsPtrList_t *	getParentUnits (const UnitClass_t aClass)
UnitsPtrList_t *	getChildrenUnits (const UnitClass_t aClass)

---

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");

---

Member Function Documentation

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

UnitClass_t openfluid::core::Unit::getClass

(

)

const [inline]

Returns the class of the unit

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

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

unsigned int 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