#include <core/SpatialUnit.hpp>
Class defining a spatial unit
example of use:
aUnitID = aUnitPtr->
getID();
openfluid::core::SpatialUnit::~SpatialUnit |
( |
| ) |
|
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 |
Returns a list of children units of the requested class. Returns nullptr if this unit has no child
- Parameters
-
[in] | aClass | the requested class |
Returns a list of units, of the requested class, connected from this unit. Returns nullptr if no units of the requested class are connected from this unit.
- Parameters
-
[in] | aClass | the requested class |
UnitsClass_t openfluid::core::SpatialUnit::getClass |
( |
| ) |
const |
|
inline |
Returns the class of the unit
UnitID_t openfluid::core::SpatialUnit::getID |
( |
| ) |
const |
|
inline |
Returns the ID of the unit
PcsOrd_t openfluid::core::SpatialUnit::getProcessOrder |
( |
| ) |
const |
|
inline |
Returns the process order of the unit
Returns a list of parent units of the requested class. Returns nullptr if this unit has no parent
- Parameters
-
[in] | aClass | the requested class |
void openfluid::core::SpatialUnit::setProcessOrder |
( |
unsigned int |
PcsOrder | ) |
|
|
inline |
void openfluid::core::SpatialUnit::streamContents |
( |
std::ostream & |
OStream | ) |
|
Returns a list of units, of the requested class, connected to this unit. Returns nullptr if no units of the requested class are connected to this unit.
- Parameters
-
[in] | aClass | the requested class |
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: