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
	Constructor.
	LevelData (WSM::ObjectHistoryID const &id, double elevation, 1::string name, double area)
WSM::ObjectHistoryID const &	getID () const
	getID() function.
double	getElevation () const
	getElevation() function.
double	getArea () const
	getArea() function.
FORMIT_CORE_EXPORT double	getAreaForObjects (size_t nHistoryId, 1::vector< size_t > const &aObjectIds)
	getAreaForObjects() function.
const ::string &	getName () const
	getName() function.
void	set (WSM::ObjectHistoryID const &id, double elevation, 1::string name, double area)
	set() function.
void	setElevation (double elevation)
	setElevation() function.
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
double	mElevation = 0.0
	elevation
double	mArea = 0.0
::string	mName
	level name

Constructor & Destructor Documentation

LevelData() [1/2]

FormIt::LevelData::LevelData ( )

default

Constructor.

LevelData() [2/2]

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

inline

Member Function Documentation

getArea()

double FormIt::LevelData::getArea ( ) const

inline

getArea() function.

getAreaForObjects()

FORMIT_CORE_EXPORT double FormIt::LevelData::getAreaForObjects	(	size_t	nHistoryId,
		1::vector< size_t > const &	aObjectIds
	)

getAreaForObjects() function.

Parameters

[in]	nHistoryId	ID of the given History
[in]	aObjectIds	Vector of objects for which to calculate the level area

getElevation()

double FormIt::LevelData::getElevation ( ) const

inline

getElevation() function.

getID()

WSM::ObjectHistoryID const & FormIt::LevelData::getID ( ) const

inline

getID() function.

getName()

const ::string & FormIt::LevelData::getName ( ) const

inline

getName() function.

operator<()

bool FormIt::LevelData::operator< ( const LevelData &  aOther ) const

inline

operator<=()

bool FormIt::LevelData::operator<= ( const LevelData &  aOther ) const

inline

operator>()

bool FormIt::LevelData::operator> ( const LevelData &  aOther ) const

inline

operator>=()

bool FormIt::LevelData::operator>= ( const LevelData &  aOther ) const

inline

set()

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

inline

set() function.

Parameters

[in]	id
[in]	elevation
[in]	name
[in]	area

setElevation()

void FormIt::LevelData::setElevation ( double  elevation )

inline

setElevation() function.

Parameters

[in]

elevation

Member Data Documentation

mArea

double FormIt::LevelData::mArea = 0.0

mElevation

double FormIt::LevelData::mElevation = 0.0

elevation

mID

WSM::ObjectHistoryID FormIt::LevelData::mID

identifier

mName

::string FormIt::LevelData::mName

level name

---

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

• Public/FormItCoreTypes.h