QueryParams#

class caf.ntem.queries.QueryParams(*years, scenario, output_zoning=ZoningSystems.NTEM_ZONE, version=Versions.EIGHT, filter_zoning_system=None, filter_zone_names=None)[source]#

Bases: ABC

Abstract base class for query classes.

Attributes

`name`	Name of the query.
`output_zone_system`	Zone system query outputs at.

Methods

`__init__`(*years, scenario[, output_zoning, ...])	Initialise QueryParams.
`query`(conn[, include_zone_name])	Query NTEM database using parameters defined on initialisation.

Attributes Documentation

Parameters:

years (int)
scenario (ntem_constants.Scenarios)
output_zoning (ntem_constants.ZoningSystems)
version (ntem_constants.Versions)
filter_zoning_system (ntem_constants.ZoningSystems | None)
filter_zone_names (list[str] | None)

name#: Name of the query.

output_zone_system#: Zone system query outputs at.