FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::LevelData Class Reference

Description

This class represents a Level in formit Core.

It contains a reference to the WSM Level object and also stores name and elevation for convenience.

#include <FormItCoreTypes.h>

Public Member Functions

 LevelData ()=default
 
 LevelData (WSM::ObjectHistoryID const &id, double elevation, 1::string name, double area)
 
WSM::ObjectHistoryID const & getID () const
 
double getElevation () const
 
double getArea () const
 
FORMIT_CORE_EXPORT double getAreaForObjects (size_t nHistoryId, 1::vector< size_t > const &aObjectIds)
 
const ::string & getName () const
 
void set (WSM::ObjectHistoryID const &id, double elevation, 1::string name, double area)
 
void setElevation (double elevation)
 
bool operator< (const LevelData &aOther) const
 
bool operator<= (const LevelData &aOther) const
 
bool operator> (const LevelData &aOther) const
 
bool operator>= (const LevelData &aOther) const
 

Public Attributes

WSM::ObjectHistoryID mID
 identifier More...
 
double mElevation = 0.0
 elevation More...
 
double mArea = 0.0
 
::string mName
 level name More...
 

Constructor & Destructor Documentation

FormIt::LevelData::LevelData ( )
default
FormIt::LevelData::LevelData ( WSM::ObjectHistoryID const &  id,
double  elevation,
1::string  name,
double  area 
)
inline

Member Function Documentation

double FormIt::LevelData::getArea ( ) const
inline
FORMIT_CORE_EXPORT double FormIt::LevelData::getAreaForObjects ( size_t  nHistoryId,
1::vector< size_t > const &  aObjectIds 
)
double FormIt::LevelData::getElevation ( ) const
inline
WSM::ObjectHistoryID const& FormIt::LevelData::getID ( ) const
inline
const ::string& FormIt::LevelData::getName ( ) const
inline
bool FormIt::LevelData::operator< ( const LevelData aOther) const
inline
bool FormIt::LevelData::operator<= ( const LevelData aOther) const
inline
bool FormIt::LevelData::operator> ( const LevelData aOther) const
inline
bool FormIt::LevelData::operator>= ( const LevelData aOther) const
inline
void FormIt::LevelData::set ( WSM::ObjectHistoryID const &  id,
double  elevation,
1::string  name,
double  area 
)
inline
void FormIt::LevelData::setElevation ( double  elevation)
inline

Member Data Documentation

double FormIt::LevelData::mArea = 0.0
double FormIt::LevelData::mElevation = 0.0

elevation

WSM::ObjectHistoryID FormIt::LevelData::mID

identifier

::string FormIt::LevelData::mName

level name


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