Manual for OpenFLUID 2.1.11

Public Member Functions | List of all members
openfluid::core::SpatialGraph Class Reference

#include <core/SpatialGraph.hpp>

Public Member Functions

 SpatialGraph ()=default
 
SpatialUnit * addUnit (const SpatialUnit &aUnit)
 
bool deleteUnit (SpatialUnit *aUnit)
 
bool removeFromToConnection (SpatialUnit *FromUnit, SpatialUnit *ToUnit)
 
bool removeChildParentConnection (SpatialUnit *ChildUnit, SpatialUnit *ParentUnit)
 
bool sortUnitsByProcessOrder ()
 
SpatialUnit * spatialUnit (const UnitsClass_t &UnitsClass, UnitID_t UnitID)
 
const SpatialUnit * spatialUnit (const UnitsClass_t &UnitsClass, UnitID_t UnitID) const
 
UnitsCollection * spatialUnits (const UnitsClass_t &UnitsClass)
 
const UnitsCollection * spatialUnits (const UnitsClass_t &UnitsClass) const
 
const UnitsListByClassMap_t * allSpatialUnitsByClass () const
 
const UnitsPtrList_t * allSpatialUnits () const
 
UnitsPtrList_t * allSpatialUnits ()
 
bool isUnitsClassExist (const UnitsClass_t &UnitsClass) const
 
void streamContents (std::ostream &OStream)
 
void clearAllVariables ()
 
void clearAllAttributes ()
 
void clearAllEvents ()
 
void clearAllData ()
 
void clearUnits ()
 

Constructor & Destructor Documentation

◆ SpatialGraph()

openfluid::core::SpatialGraph::SpatialGraph ( )
default

Member Function Documentation

◆ addUnit()

SpatialUnit* openfluid::core::SpatialGraph::addUnit ( const SpatialUnit &  aUnit)

◆ allSpatialUnits() [1/2]

UnitsPtrList_t* openfluid::core::SpatialGraph::allSpatialUnits ( )
inline

◆ allSpatialUnits() [2/2]

const UnitsPtrList_t* openfluid::core::SpatialGraph::allSpatialUnits ( ) const
inline

◆ allSpatialUnitsByClass()

const UnitsListByClassMap_t* openfluid::core::SpatialGraph::allSpatialUnitsByClass ( ) const
inline

◆ clearAllAttributes()

void openfluid::core::SpatialGraph::clearAllAttributes ( )

◆ clearAllData()

void openfluid::core::SpatialGraph::clearAllData ( )

◆ clearAllEvents()

void openfluid::core::SpatialGraph::clearAllEvents ( )

◆ clearAllVariables()

void openfluid::core::SpatialGraph::clearAllVariables ( )

◆ clearUnits()

void openfluid::core::SpatialGraph::clearUnits ( )

◆ deleteUnit()

bool openfluid::core::SpatialGraph::deleteUnit ( SpatialUnit *  aUnit)

◆ isUnitsClassExist()

bool openfluid::core::SpatialGraph::isUnitsClassExist ( const UnitsClass_t &  UnitsClass) const

◆ removeChildParentConnection()

bool openfluid::core::SpatialGraph::removeChildParentConnection ( SpatialUnit *  ChildUnit,
SpatialUnit *  ParentUnit 
)

◆ removeFromToConnection()

bool openfluid::core::SpatialGraph::removeFromToConnection ( SpatialUnit *  FromUnit,
SpatialUnit *  ToUnit 
)

◆ sortUnitsByProcessOrder()

bool openfluid::core::SpatialGraph::sortUnitsByProcessOrder ( )

◆ spatialUnit() [1/2]

SpatialUnit* openfluid::core::SpatialGraph::spatialUnit ( const UnitsClass_t &  UnitsClass,
UnitID_t  UnitID 
)

◆ spatialUnit() [2/2]

const SpatialUnit* openfluid::core::SpatialGraph::spatialUnit ( const UnitsClass_t &  UnitsClass,
UnitID_t  UnitID 
) const

◆ spatialUnits() [1/2]

UnitsCollection* openfluid::core::SpatialGraph::spatialUnits ( const UnitsClass_t &  UnitsClass)

◆ spatialUnits() [2/2]

const UnitsCollection* openfluid::core::SpatialGraph::spatialUnits ( const UnitsClass_t &  UnitsClass) const

◆ streamContents()

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

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