The ra_api.py module

Summary

Exceptions

RockyApiError

Exception class representing an error generated in the API layer.

Functions

CheckResults	Helper function to check if the project has simulation results and raise an error with a
CheckPropAffectsSimulation	Helper function to check if the property (given by prop_name) affects the simulation results.

Module detail

ra_api.CheckResults(ra_object) → None

Helper function to check if the project has simulation results and raise an error with a helpful message. Should be called by API methods that would invalidate simulation results.

ra_api.CheckPropAffectsSimulation(prop_owner, prop_name)

Helper function to check if the property (given by prop_name) affects the simulation results.