#include <core/SpatialUnit.hpp>
Class defining a spatial unit
example of use:
aUnitID = aUnitPtr->
getID();
◆ SpatialUnit()
◆ ~SpatialUnit()
openfluid::core::SpatialUnit::~SpatialUnit |
( |
| ) |
|
◆ addChildUnit()
bool openfluid::core::SpatialUnit::addChildUnit |
( |
SpatialUnit * |
aUnit | ) |
|
◆ addFromUnit()
bool openfluid::core::SpatialUnit::addFromUnit |
( |
SpatialUnit * |
aUnit | ) |
|
◆ addParentUnit()
bool openfluid::core::SpatialUnit::addParentUnit |
( |
SpatialUnit * |
aUnit | ) |
|
◆ addToUnit()
bool openfluid::core::SpatialUnit::addToUnit |
( |
SpatialUnit * |
aUnit | ) |
|
◆ attributes() [1/2]
Attributes* openfluid::core::SpatialUnit::attributes |
( |
| ) |
|
|
inline |
◆ attributes() [2/2]
const Attributes* openfluid::core::SpatialUnit::attributes |
( |
| ) |
const |
|
inline |
◆ childSpatialUnits() [1/2]
Returns a list of children units of the requested class. Returns nullptr if this unit has no child
- Parameters
-
[in] | aClass | the requested class |
◆ childSpatialUnits() [2/2]
◆ deleteGeometry()
void openfluid::core::SpatialUnit::deleteGeometry |
( |
| ) |
|
◆ events() [1/2]
◆ events() [2/2]
◆ exportGeometryToWkt()
std::string openfluid::core::SpatialUnit::exportGeometryToWkt |
( |
| ) |
const |
◆ fromSpatialUnits() [1/2]
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 |
◆ fromSpatialUnits() [2/2]
◆ geometry() [1/2]
OGRGeometry* openfluid::core::SpatialUnit::geometry |
( |
| ) |
|
|
inline |
◆ geometry() [2/2]
const OGRGeometry* openfluid::core::SpatialUnit::geometry |
( |
| ) |
const |
|
inline |
◆ getChildrenUnits() [1/2]
◆ getChildrenUnits() [2/2]
◆ getClass()
UnitsClass_t openfluid::core::SpatialUnit::getClass |
( |
| ) |
const |
|
inline |
Returns the class of the unit
◆ getFromUnits() [1/2]
◆ getFromUnits() [2/2]
◆ getID()
UnitID_t openfluid::core::SpatialUnit::getID |
( |
| ) |
const |
|
inline |
Returns the ID of the unit
◆ getParentUnits() [1/2]
◆ getParentUnits() [2/2]
◆ getProcessOrder()
PcsOrd_t openfluid::core::SpatialUnit::getProcessOrder |
( |
| ) |
const |
|
inline |
Returns the process order of the unit
◆ getToUnits() [1/2]
◆ getToUnits() [2/2]
◆ importGeometryFromWkt()
bool openfluid::core::SpatialUnit::importGeometryFromWkt |
( |
const std::string & |
WKT | ) |
|
◆ parentSpatialUnits() [1/2]
Returns a list of parent units of the requested class. Returns nullptr if this unit has no parent
- Parameters
-
[in] | aClass | the requested class |
◆ parentSpatialUnits() [2/2]
◆ setProcessOrder()
void openfluid::core::SpatialUnit::setProcessOrder |
( |
unsigned int |
PcsOrder | ) |
|
|
inline |
◆ streamContents()
void openfluid::core::SpatialUnit::streamContents |
( |
std::ostream & |
OStream | ) |
|
◆ toSpatialUnits() [1/2]
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 |
◆ toSpatialUnits() [2/2]
◆ variables() [1/2]
Variables* openfluid::core::SpatialUnit::variables |
( |
| ) |
|
|
inline |
◆ variables() [2/2]
const Variables* openfluid::core::SpatialUnit::variables |
( |
| ) |
const |
|
inline |
The documentation for this class was generated from the following file: