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

#include <VICUS_NetworkPipe.h>

Inheritance diagram for VICUS::NetworkPipe:
[legend]

Public Types

enum  para_t {
  P_DiameterOutside , P_ThicknessWall , P_RoughnessWall , P_ThermalConductivityWall ,
  P_HeatCapacityWall , P_DensityWall , P_ThicknessInsulation , P_ThermalConductivityInsulation ,
  NUM_P
}
 
- Public Types inherited from VICUS::AbstractDBElement
enum  ComparisonResult { Equal , OnlyMetaDataDiffers , Different }
 

Public Member Functions

VICUS_READWRITE_OVERRIDE VICUS_COMPARE_WITH_ID double UValue () const
 
double diameterInside () const
 
bool isValid () const
 
ComparisonResult equal (const AbstractDBElement *other) const override
 
IBK::MultiLanguageString nameFromData () const
 
- Public Member Functions inherited from VICUS::AbstractDBElement
 AbstractDBElement ()=default
 
 AbstractDBElement (unsigned int id, const IBK::MultiLanguageString &name)
 
virtual ~AbstractDBElement ()
 
virtual void readXML (const TiXmlElement *element)=0
 
virtual TiXmlElement * writeXML (TiXmlElement *parent) const =0
 
void collectChildren (std::set< const AbstractDBElement * > &allChildrenRefs) const
 
void collectLocalChildren (std::set< AbstractDBElement * > &localChildrenRefs) const
 
const QString sourceName () const
 

Public Attributes

IBK::MultiLanguageString m_categoryName
 
IBK::Parameter m_para [NUM_P]
 
- Public Attributes inherited from VICUS::AbstractDBElement
unsigned int m_id = INVALID_ID
 
IBK::MultiLanguageString m_displayName
 
QColor m_color
 
bool m_builtIn = false
 
bool m_local = true
 
std::set< AbstractDBElement * > m_childrenRefs
 
bool m_isReferenced = false
 
std::string m_errorMsg
 

Member Enumeration Documentation

◆ para_t

Enumerator
P_DiameterOutside 

This is the diameter of the pipe, not including any insulation around it.

P_ThicknessWall 
P_RoughnessWall 
P_ThermalConductivityWall 
P_HeatCapacityWall 
P_DensityWall 
P_ThicknessInsulation 
P_ThermalConductivityInsulation 
NUM_P 

Member Function Documentation

◆ diameterInside()

double VICUS::NetworkPipe::diameterInside ( ) const

Returns the inner pipe diameter in [m].

Warning
Parameters are not checked for validity. If used unchecked, result may be negative or zero.

◆ equal()

VICUS::AbstractDBElement::ComparisonResult VICUS::NetworkPipe::equal ( const AbstractDBElement other) const
overridevirtual

Comparison operator

Implements VICUS::AbstractDBElement.

◆ isValid()

bool VICUS::NetworkPipe::isValid ( ) const

Checks if all parameters are valid.

◆ nameFromData()

IBK::MultiLanguageString VICUS::NetworkPipe::nameFromData ( ) const

Generates a display name from category and entered pipe dimensions.

◆ UValue()

double VICUS::NetworkPipe::UValue ( ) const

Calculates the effective U-value per m length of pipe in [W/mK].

Member Data Documentation

◆ m_categoryName

IBK::MultiLanguageString VICUS::NetworkPipe::m_categoryName

A custom category name.

◆ m_para

IBK::Parameter VICUS::NetworkPipe::m_para[NUM_P]

Pipe parameters.


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