#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)

OGRGeometry *	geometry ()

const OGRGeometry *	geometry () const

bool	importGeometryFromWkt (const std::string &WKT)

std::string	exportGeometryToWkt () const

void	deleteGeometry ()

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

◆ SpatialUnit()

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

◆ ~SpatialUnit()

openfluid::core::SpatialUnit::~SpatialUnit ( )

Member Function Documentation

◆ 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]

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

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]

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

◆ deleteGeometry()

void openfluid::core::SpatialUnit::deleteGeometry ( )

◆ events() [1/2]

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

inline

◆ events() [2/2]

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

inline

◆ exportGeometryToWkt()

std::string openfluid::core::SpatialUnit::exportGeometryToWkt ( ) const

◆ fromSpatialUnits() [1/2]

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

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]

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

◆ geometry() [1/2]

OGRGeometry* openfluid::core::SpatialUnit::geometry ( )

inline

◆ geometry() [2/2]

const OGRGeometry* openfluid::core::SpatialUnit::geometry ( ) const

inline

◆ getChildrenUnits() [1/2]

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

◆ getChildrenUnits() [2/2]

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

◆ getClass()

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

inline

Returns the class of the unit

◆ getFromUnits() [1/2]

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

◆ getFromUnits() [2/2]

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

◆ getID()

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

inline

Returns the ID of the unit

◆ getParentUnits() [1/2]

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

◆ getParentUnits() [2/2]

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

◆ getProcessOrder()

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

inline

Returns the process order of the unit

◆ getToUnits() [1/2]

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

◆ getToUnits() [2/2]

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

◆ importGeometryFromWkt()

bool openfluid::core::SpatialUnit::importGeometryFromWkt ( const std::string & WKT )

◆ parentSpatialUnits() [1/2]

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

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]

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

◆ setProcessOrder()

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

inline

◆ streamContents()

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

◆ toSpatialUnits() [1/2]

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

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]

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

◆ 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:

core/SpatialUnit.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SpatialUnit()

◆ ~SpatialUnit()

Member Function Documentation

◆ addChildUnit()

◆ addFromUnit()

◆ addParentUnit()

◆ addToUnit()

◆ attributes() [1/2]

◆ attributes() [2/2]

◆ childSpatialUnits() [1/2]

◆ childSpatialUnits() [2/2]

◆ deleteGeometry()

◆ events() [1/2]

◆ events() [2/2]

◆ exportGeometryToWkt()

◆ fromSpatialUnits() [1/2]

◆ fromSpatialUnits() [2/2]

◆ geometry() [1/2]

◆ geometry() [2/2]

◆ getChildrenUnits() [1/2]

◆ getChildrenUnits() [2/2]

◆ getClass()

◆ getFromUnits() [1/2]

◆ getFromUnits() [2/2]

◆ getID()

◆ getParentUnits() [1/2]

◆ getParentUnits() [2/2]

◆ getProcessOrder()

◆ getToUnits() [1/2]

◆ getToUnits() [2/2]

◆ importGeometryFromWkt()

◆ parentSpatialUnits() [1/2]

◆ parentSpatialUnits() [2/2]

◆ setProcessOrder()

◆ streamContents()

◆ toSpatialUnits() [1/2]

◆ toSpatialUnits() [2/2]

◆ variables() [1/2]

◆ variables() [2/2]