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

#include <VICUS_NetworkElement.h>

Public Member Functions

 NetworkElement ()=default
 
 NetworkElement (unsigned int id, unsigned int inletNodeId, unsigned int outletNodeId, unsigned int componentId)
 

Public Attributes

VICUS_READWRITE VICUS_COMPARE_WITH_ID IDType m_id = VICUS::INVALID_ID
 
IDType m_inletNodeId = VICUS::INVALID_ID
 
IDType m_outletNodeId = VICUS::INVALID_ID
 
IDType m_componentId = VICUS::INVALID_ID
 
IDType m_controlElementId = VICUS::INVALID_ID
 
QString m_displayName
 

Detailed Description

Data model object for network components, similar as NANDRAD::HydraulicNetworkElement with data members needed in the user interface.

Note: In contrast to NANDRAD::HydraulicNetworkElement, we dont store a pipePropertiesId here, this is done in VICUS::NetworkComponent

Constructor & Destructor Documentation

◆ NetworkElement() [1/2]

VICUS::NetworkElement::NetworkElement ( )
default

◆ NetworkElement() [2/2]

VICUS::NetworkElement::NetworkElement ( unsigned int  id,
unsigned int  inletNodeId,
unsigned int  outletNodeId,
unsigned int  componentId 
)
inline

C'tor for a network element other than pipes.

Member Data Documentation

◆ m_componentId

IDType VICUS::NetworkElement::m_componentId = VICUS::INVALID_ID

Network component ID.

◆ m_controlElementId

IDType VICUS::NetworkElement::m_controlElementId = VICUS::INVALID_ID

Optional reference to a flow controller element.

◆ m_displayName

QString VICUS::NetworkElement::m_displayName

Display name.

◆ m_id

Unique ID for this flow component. ID is used for outputs and to reference heat sources/sinks connected to this element. For active elements, this ID is used to connect control models.

◆ m_inletNodeId

IDType VICUS::NetworkElement::m_inletNodeId = VICUS::INVALID_ID

Inlet node ID.

◆ m_outletNodeId

IDType VICUS::NetworkElement::m_outletNodeId = VICUS::INVALID_ID

Outlet node ID.


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