bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models package

Package for Python representations of HKESim models

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.Boiler(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.Boilers.Boiler'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.Boiler'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.BoilerModule(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'SystemModules.HeatingSystemModules.BoilerModule'

represents: Element | Container[Element] = [<class 'bim2sim.elements.aggregation.hvac_aggregations.GeneratorOneFluid'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.CHP(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.CHPs.CHP'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.CHP'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.Chiller(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.Chillers.CompressionChiller'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.Chiller'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.ConsumerHeatingDistributorModule(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'SystemModules.HeatingSystemModules.ConsumerHeatingDistributorModule'

represents: Element | Container[Element] = [<class 'bim2sim.elements.aggregation.hvac_aggregations.ConsumerHeatingDistributorModule'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.CoolingTower(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.CoolingTowers.CoolingTower'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.CoolingTower'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.HKESim(element: HVACProduct)

Bases: ModelicaElement

library: str = 'HKESim'

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.HeatPump(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.HeatPumps.HeatPump'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.HeatPump'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.Pump(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.Pumps.Pump'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.Pump'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.Radiator(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.Consumers.Consumer'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.SpaceHeater'>, <class 'bim2sim.elements.aggregation.hvac_aggregations.Consumer'>]

class bim2sim.plugins.PluginHKESim.bim2sim_hkesim.models.ThreeWayValve(element)

Bases: HKESim

get_port_name(port)

Get the name of port. Override this method in a subclass.

Args:

port: The HVACPort for which to get the name.

Returns:

The name of the port as string.

path: str = 'HKESim.Heating.Hydraulics.Valves.ThreeWayValveControlled'

represents: Element | Container[Element] = [<class 'bim2sim.elements.hvac_elements.ThreeWayValve'>]