Documentation for OpenFLUID 2.2.0
openfluid::fluidx::SpatialUnitDescriptor Class Reference

#include <fluidx/SpatialUnitDescriptor.hpp>

Public Member Functions

 SpatialUnitDescriptor ()
 
 ~SpatialUnitDescriptor ()
 
openfluid::core::UnitID_t getID () const
 
void setID (openfluid::core::UnitID_t ID)
 
const openfluid::core::UnitsClass_t getUnitsClass () const
 
void setUnitsClass (const openfluid::core::UnitsClass_t &UClass)
 
openfluid::core::PcsOrd_t getProcessOrder () const
 
void setProcessOrder (openfluid::core::PcsOrd_t Order)
 
std::list< openfluid::core::UnitClassID_t > & toSpatialUnits ()
 
const std::list< openfluid::core::UnitClassID_t > & toSpatialUnits () const
 
std::list< openfluid::core::UnitClassID_t > & parentSpatialUnits ()
 
const std::list< openfluid::core::UnitClassID_t > & parentSpatialUnits () const
 
std::map< openfluid::core::AttributeName_t, std::string > & attributes ()
 
const std::map< openfluid::core::AttributeName_t, std::string > & attributes () const
 
const std::list< openfluid::fluidx::EventDescriptor > & events () const
 
std::list< openfluid::fluidx::EventDescriptor > & events ()
 

Constructor & Destructor Documentation

◆ SpatialUnitDescriptor()

openfluid::fluidx::SpatialUnitDescriptor::SpatialUnitDescriptor ( )

◆ ~SpatialUnitDescriptor()

openfluid::fluidx::SpatialUnitDescriptor::~SpatialUnitDescriptor ( )

Member Function Documentation

◆ attributes() [1/2]

std::map<openfluid::core::AttributeName_t,std::string>& openfluid::fluidx::SpatialUnitDescriptor::attributes ( )
inline

◆ attributes() [2/2]

const std::map<openfluid::core::AttributeName_t,std::string>& openfluid::fluidx::SpatialUnitDescriptor::attributes ( ) const
inline

◆ events() [1/2]

std::list<openfluid::fluidx::EventDescriptor>& openfluid::fluidx::SpatialUnitDescriptor::events ( )
inline

◆ events() [2/2]

const std::list<openfluid::fluidx::EventDescriptor>& openfluid::fluidx::SpatialUnitDescriptor::events ( ) const
inline

◆ getID()

openfluid::core::UnitID_t openfluid::fluidx::SpatialUnitDescriptor::getID ( ) const
inline

◆ getProcessOrder()

openfluid::core::PcsOrd_t openfluid::fluidx::SpatialUnitDescriptor::getProcessOrder ( ) const
inline

◆ getUnitsClass()

const openfluid::core::UnitsClass_t openfluid::fluidx::SpatialUnitDescriptor::getUnitsClass ( ) const
inline

◆ parentSpatialUnits() [1/2]

std::list<openfluid::core::UnitClassID_t>& openfluid::fluidx::SpatialUnitDescriptor::parentSpatialUnits ( )
inline

◆ parentSpatialUnits() [2/2]

const std::list<openfluid::core::UnitClassID_t>& openfluid::fluidx::SpatialUnitDescriptor::parentSpatialUnits ( ) const
inline

◆ setID()

void openfluid::fluidx::SpatialUnitDescriptor::setID ( openfluid::core::UnitID_t  ID)
inline

◆ setProcessOrder()

void openfluid::fluidx::SpatialUnitDescriptor::setProcessOrder ( openfluid::core::PcsOrd_t  Order)
inline

◆ setUnitsClass()

void openfluid::fluidx::SpatialUnitDescriptor::setUnitsClass ( const openfluid::core::UnitsClass_t UClass)
inline

◆ toSpatialUnits() [1/2]

std::list<openfluid::core::UnitClassID_t>& openfluid::fluidx::SpatialUnitDescriptor::toSpatialUnits ( )
inline

◆ toSpatialUnits() [2/2]

const std::list<openfluid::core::UnitClassID_t>& openfluid::fluidx::SpatialUnitDescriptor::toSpatialUnits ( ) const
inline

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