DbsBenefit

dbs_classes.DbsBenefit(self, database: IDatabase)

Methods

Name	Description
delete	Delete an already existing benefit in the database.
edit	Edits an already existing benefit in the database.
ready_to_run	Check if all the required scenarios have already been run.
save	Save a benefit object in the database.

delete

dbs_classes.DbsBenefit.delete(name: str, toml_only: bool = False)

Delete an already existing benefit in the database.

Parameters

name : str

name of the benefit

toml_only : bool = False

whether to only delete the toml file or the entire folder. If the folder is empty after deleting the toml, it will always be deleted. By default False

Raises

: ValueError

Raise error if benefit has already model output

edit

dbs_classes.DbsBenefit.edit(benefit: Benefit)

Edits an already existing benefit in the database.

Parameters

benefit : Benefit

benefit to be edited in the database

Raises

: ValueError

Raise error if name is already in use.

ready_to_run

dbs_classes.DbsBenefit.ready_to_run(name: str)

Check if all the required scenarios have already been run.

Returns

: bool

True if required scenarios have been already run

save

dbs_classes.DbsBenefit.save(object_model: Benefit, overwrite: bool = False)

Save a benefit object in the database.

Parameters

object_model : Benefit

object of Benefit type

overwrite : bool = False

whether to overwrite existing benefit with same name, by default False

Raises

: ValueError

Raise error if name is already in use. Names of benefits assessments should be unique.