dbs_classes.dbs_event.DbsEvent
dbs_classes.dbs_event.DbsEvent(self, database)Methods
| Name | Description |
|---|---|
| check_higher_level_usage | Check if an event is used in a scenario. |
| copy | Copy (duplicate) an existing object, and give it a new name. |
| get | Return an event object. |
| list_objects | Return a dictionary with info on the events that currently exist in the database. |
check_higher_level_usage
dbs_classes.dbs_event.DbsEvent.check_higher_level_usage(name)Check if an event is used in a scenario.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| name | str | name of the event to be checked | required |
Returns
| Name | Type | Description |
|---|---|---|
| list[str] | list of scenarios that use the event |
copy
dbs_classes.dbs_event.DbsEvent.copy(old_name, new_name, new_description)Copy (duplicate) an existing object, and give it a new name.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| old_name | str | name of the existing measure | required |
| new_name | str | name of the new measure | required |
| new_description | str | description of the new measure | required |
get
dbs_classes.dbs_event.DbsEvent.get(name)Return an event object.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| name | str | name of the event to be returned | required |
Returns
| Name | Type | Description |
|---|---|---|
| Event | event object |
list_objects
dbs_classes.dbs_event.DbsEvent.list_objects()Return a dictionary with info on the events that currently exist in the database.
Returns
| Name | Type | Description |
|---|---|---|
| dict[str, Any] | Includes ‘name’, ‘description’, ‘path’ and ‘last_modification_date’ info |