VICUS Library
Documentation of Vicus library
Loading...
Searching...
No Matches
VICUS::MaterialLayer Class Reference

#include <VICUS_MaterialLayer.h>

Public Member Functions

 MaterialLayer ()
 
 MaterialLayer (double thickness, unsigned int id)
 
 MaterialLayer (IBK::Parameter thickness, unsigned int id)
 
VICUS_READWRITE bool isValid (const VICUS::Database< VICUS::Material > &materials) const
 
bool operator!= (const MaterialLayer &other) const
 
bool operator== (const MaterialLayer &other) const
 

Public Attributes

unsigned int m_idMaterial = INVALID_ID
 
IBK::Parameter m_thickness
 
std::string m_errorMsg
 

Detailed Description

Stores data for a single material layer in a construction.

Constructor & Destructor Documentation

◆ MaterialLayer() [1/3]

VICUS::MaterialLayer::MaterialLayer ( )
inline

Default c'tor.

◆ MaterialLayer() [2/3]

VICUS::MaterialLayer::MaterialLayer ( double  thickness,
unsigned int  id 
)
inline

Simple Constructor with thickness in [m] and material id.

◆ MaterialLayer() [3/3]

VICUS::MaterialLayer::MaterialLayer ( IBK::Parameter  thickness,
unsigned int  id 
)
inline

Simple Constructor with thickness and material id.

Member Function Documentation

◆ isValid()

bool VICUS::MaterialLayer::isValid ( const VICUS::Database< VICUS::Material > &  materials) const

Checks if all referenced materials exist and if their parameters are valid.

◆ operator!=()

bool VICUS::MaterialLayer::operator!= ( const MaterialLayer other) const
inline

Inequality operator.

◆ operator==()

bool VICUS::MaterialLayer::operator== ( const MaterialLayer other) const
inline

Equality operator.

Member Data Documentation

◆ m_errorMsg

std::string VICUS::MaterialLayer::m_errorMsg
mutable

Holds error string in order to give users a tooltip in db dialog.

◆ m_idMaterial

unsigned int VICUS::MaterialLayer::m_idMaterial = INVALID_ID

Unique ID of material.

◆ m_thickness

IBK::Parameter VICUS::MaterialLayer::m_thickness

Thickness of the material layer.


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